API Reference

Integrate oqui assessments into your applications with our REST API.

The oqui API allows you to programmatically submit affordability assessments and retrieve results. This is ideal for integrating assessments into your existing loan origination systems, CRMs, or custom applications.

Overview

The API follows REST conventions:

Base URL: https://oqui.io/api/v1
Authentication: Bearer token (API key)
Format: JSON request/response
Rate limit: 60 requests/minute per API key

Quick start

Generate an API key in your dashboard (Settings > Developer > API Keys)
Submit an assessment with documents
Poll for results or receive via webhook

API sections

Authentication

How to authenticate API requests using API keys.

Learn about authentication

Submit Assessment

Submit documents for processing and get a job ID.

Learn about submitting

Get Results

Poll for assessment results or configure webhooks.

Learn about getting results

OpenAPI specification

A full OpenAPI 3.0 specification is available for API clients and documentation generation:

GET https://oqui.io/api/v1/openapi.json

SDKs and libraries

We provide official SDKs for common languages:

TypeScript/JavaScript - npm package coming soon
Python - pip package coming soon

In the meantime, use any HTTP client with our REST API directly.