Documentation

Build with Waaza

REST API, embeddable widget, webhook events, and platform guides. Everything needed to embed Waaza's financing intelligence into your workflow or platform.

POST /v1/assessments
Authorization: Bearer <your-api-key>

{
  "buyer": {
    "liquidity": 500000,
    "net_worth_band": "1m_5m",
    "income_type": "business",
    "residency": "GB"
  },
  "vessel": {
    "purchase_price": 2200000,
    "year_built": 2018,
    "usage_type": "private",
    "intended_flag": "KY"
  }
}
View API reference →Try a live assessment

Getting started

Guide
Overview
What Waaza is, how the API works, and where to start.
→Reference
Authentication
API key setup, request headers, and rate limits.
→Tutorial
Quick start
Run your first assessment in five minutes.
→

API reference

Endpoint
POST /v1/assessments
Run a financing readiness assessment. Returns score, LTV band, and risk flags.
→Endpoint
GET /v1/assessments/:id
Retrieve a stored assessment by ID.
→Endpoint
POST /v1/reports
Generate a PDF or web report from an assessment.
→Endpoint
GET /v1/reports/:id
Retrieve a generated report.
→

Widget integration

Guide
Widget overview
The embeddable financing readiness widget — fields, output, and customisation.
→Tutorial
Script installation
One-line embed for broker portals, listing sites, and marketplace platforms.
→Reference
Configuration options
Branding, field visibility, CTA customisation, and callback events.
→Example
Findaly integration
The reference integration — how Waaza embeds in a boat listing marketplace.
→

Platform

Guide
Assessment engine
How the rule engine works — inputs, outputs, versioning, and rule sets.
→Reference
Readiness scoring
Score components, weights, tier thresholds, and interpretation.
→Reference
Report format
Report sections, field definitions, and PDF generation.
→Reference
Webhooks
Event-driven notifications for assessment completion and report generation.
→

Get API access

API access is available for broker networks and marketplace integrations. Start with a live assessment to see what the API produces — then get in touch to discuss integration.

Try a live assessment →Talk to us about API access