Skip to content
Quickli:Docs

Public API Overview

Quickli Public API

Section titled “Quickli Public API”

The Quickli Public API provides programmatic access to mortgage scenario management, servicing calculations, lender products, and lending policies. This API enables external integrations, automation tools, and AI assistants to interact with Quickli’s mortgage calculation platform.

Base URL

Section titled “Base URL”
https://api.quickli.com

All API endpoints are prefixed with /api/v1/.

Current Status

Section titled “Current Status”

The API is currently in v1 with the following endpoints available:

  • ✅ Read Limited User Access Data - Get authenticated user info and accessible teams
  • ✅ Scenarios - Create, read, and update mortgage scenarios
  • ✅ Compute - Calculate servicing/borrowing capacity for specific lenders
  • ✅ Products - Retrieve lender product information
  • ✅ Policies - Query lending policies by lender and trigger

Quick Start

Section titled “Quick Start”

1. Get Your API Credentials

Section titled “1. Get Your API Credentials”

Contact your Quickli account manager to obtain:

  • Client ID - Your unique client identifier
  • Access Token - UUID token scoped to your organization

You will also need to:

  1. Generate an RSA key pair (2048-bit recommended)
  2. Share your public key with Quickli for registration

2. Make Your First Request

Section titled “2. Make Your First Request”

All requests require RSA signature-based authentication. See the Authentication Guide for signing implementation details.

Terminal window
# Get your user info and available teams
curl -X GET https://api.quickli.com/api/v1/user \
  -H "X-Auth-Client-ID: {clientId}" \
  -H "X-Auth-Access-Token: {accessToken}" \
  -H "X-Auth-Timestamp: {timestamp}" \
  -H "X-Auth-Nonce: {nonce}" \
  -H "X-Auth-Signature: {signature}"

3. Explore the Documentation

Section titled “3. Explore the Documentation”

Interactive Documentation

Section titled “Interactive Documentation”

For interactive API exploration and testing, visit our Swagger UI:

https://api.quickli.com/docs

You can also download the OpenAPI specification:

https://api.quickli.com/api/v1/openapi.json

Key Features

Section titled “Key Features”

🔐 RSA Signature Authentication

Section titled “🔐 RSA Signature Authentication”

Secure request signing using RSA-SHA256:

  • Client ID and access token for identification
  • Timestamp and nonce for replay protection
  • RSA signature for request integrity

🏢 Multi-Tenant Access Control

Section titled “🏢 Multi-Tenant Access Control”
  • Organization-level scoping (1 org per token)
  • Team-level permissions (multiple teams per token)
  • User-based authorization with granular access control

📊 Access to Quickli Servicing Calculations

Section titled “📊 Access to Quickli Servicing Calculations”
  • Servicing calculator integration for all major lenders
  • Detailed validation checks and warnings

🔄 Automatic Documentation

Section titled “🔄 Automatic Documentation”
  • OpenAPI 3.0 specification auto-generated from schemas
  • Always in sync with the implementation
  • Interactive Swagger UI for testing

Use Cases

Section titled “Use Cases”

Rate Limits

Section titled “Rate Limits”

Rate limiting is currently not enforced but will be implemented per-client in future releases.

Recommended best practices:

  • Implement exponential backoff for failed requests
  • Cache responses when appropriate
  • Batch operations where possible

Versioning

Section titled “Versioning”

The API uses URL-based versioning (/api/v1/). Breaking changes will result in a new version (/api/v2/), while backwards-compatible changes will be added to the current version.

What’s considered a breaking change:

Section titled “What’s considered a breaking change:”
  • Removing or renaming fields
  • Changing field types in a significant way
  • Adding required fields that are not handled by our workflow automatically
  • Changing authentication requirements

What’s backwards-compatible:

Section titled “What’s backwards-compatible:”
  • Adding new optional fields
  • Adding new endpoints
  • Adding new enum values
  • Bug fixes and performance improvements

Support

Section titled “Support”

For API support, questions, or feature requests:

Next Steps

Section titled “Next Steps”
  1. Set up authentication - Learn RSA signature authentication
  2. Browse endpoints - Explore available API operations
  3. Review schemas - Learn about data structures
  4. Test with Swagger - Try the API interactively

Last updated: 2025-11-19