Skip to main content
The Ultiwrite Partner API connects your backend to the same account, evidence workflow and saved reports as the website. The live OpenAPI document defines request and response schemas; these guides explain how to combine the operations into a complete integration. This documentation portal presents the existing API contract. It does not introduce a second endpoint, credential system or report workflow.

​
Contract authority

Use the generated OpenAPI 3.1 document and the native API reference for the deployed contract. The base URL is https://dwsoffshorepartners.com/api/v1. The schema contains Partner API operations and separately identified historical scoring routes. Their credentials have different authority. Use the Partner API for evidence-package investigations.

​
Partner operations

All paths below are relative to /api/v1.

​
Authentication and account authority

Approved accounts can use a dashboard-issued ultiwrite_live_ key or delegated OAuth with PKCE S256. Both use the same account request allowance. The credential determines the account; a request cannot select another organization. Partner OAuth uses resource https://dwsoffshorepartners.com/api/v1 and scopes ultiwrite:read and ultiwrite:evidence. An MCP token and a legacy uw_live_ key cannot replace Partner API credentials. See authentication and API keys.

​
Saved-case lifecycle

Submit evidence, retain the returned caseId, read status, and follow any returned continuation. Status reads alone do not advance processing. A completed investigation links a saved report; findings and brief reads retrieve that result rather than running another investigation. Preserve the original filenames, bytes and forensic choice when recovering an uncertain submission. Identical package retries, continuation and result reads do not consume another analysis credit. Every admitted Partner API request still counts toward the request allowance. See case workflow and usage.

​
Results and delivery

Findings pagination binds eight cursors, the saved report snapshot and the previous page token. Preserve provenance, confidence, counter-evidence and limitations when presenting results. See results and delivery. Export returns entitled delivery options. Binary PDF, Excel and ZIP downloads require a signed-in browser session on the same account. An API bearer credential does not download those bytes.

​
Integration boundaries

Optional workflow webhooks are available only where live OpenAPI includes their operations and GET /capabilities reports webhooks.available. Management requires an approved dashboard API key with read and evidence scopes; OAuth cannot manage destinations. Notifications do not advance continuation and contain minimal metadata. Read the receiver signature, deduplication, retry and revocation contract. The current contract does not offer client-credentials authentication, append-evidence or rerun endpoints, selectable investigation tiers in requests, or unattended binary downloads. A report is advisory evidence for your workflow; it does not render an autonomous approve or decline. Use the complete developer guide, downloadable README and Node examples, and integration checklist before sending customer evidence.