> ## Documentation Index > Fetch the complete documentation index at: https://docs.trycactus.com/llms.txt > Use this file to discover all available pages before exploring further. # Start an automated underwriting run > Kicks off the full automated underwriting workflow for a property. Documents are optional; when provided they are validated, accepted, and billed per the rate card, then ingested before the run starts. On completion, the notification email receives a signed link to the hosted financial-analysis report, and `underwriting.completed` is delivered to registered webhook endpoints. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v1/underwritings openapi: 3.1.0 info: title: Cactus Partner API version: 1.0.0-draft.1 summary: Document extraction and automated underwriting for CRE. description: | # Overview The Cactus Partner API provides two products: - **Extraction** — upload commercial real estate documents (offering memoranda, rent rolls, T-12 / operating statements, and other business documents) and receive structured, validated JSON with per-field confidence. - **Underwriting** — provide a property address, asset class, and notification email (documents optional) to run a full automated underwriting; results are delivered as a hosted financial-analysis report link plus a machine-readable summary. ## Authentication Every request carries an API key: `Authorization: Bearer ck_live_...` (or `ck_sandbox_...`). Keys are issued by Cactus at kickoff, are scoped per product, and can be rotated or revoked at any time. ## Sandbox `ck_sandbox_` keys hit the same endpoints but never debit your usage pool: uploads are accepted, and jobs return deterministic fixture output within seconds. Use sandbox keys for integration development and CI. ## Asynchronous jobs Extractions and underwritings are asynchronous. Create the job (`202 Accepted`), then either poll the job resource or register a webhook endpoint to receive signed events (recommended). Typical extraction turnaround is minutes. ## Billing semantics A document is **accepted** when it passes validation (size caps, page/row counts, type resolution). Acceptance debits your usage pool at the fixed rate-card price for the document type — before processing, so pricing is deterministic. Rejected documents are never charged. Documents exceeding their type's size cap bill as multiple units of the same type; the accept response discloses `billed.units`. Files over 500 pages or 100 MB are rejected outright. ## Idempotency All `POST` endpoints accept an `Idempotency-Key` header (any unique string, e.g. a UUID). Retrying a request with the same key returns the original response instead of creating a duplicate. ## Errors Errors follow RFC 9457 (`application/problem+json`) and always include a stable machine-readable `code` and the `request_id` to quote in support requests. ## Versioning The path major version (`/v1`) changes only for breaking API changes. Extraction output schemas are versioned independently per document type (e.g. `rent_roll.v1`) and declared in every result; breaking output changes ship as a new schema version with advance notice and an overlap window. --- All field-level output schemas — `RentRollData` (`rent_roll.v1`), `T12Data` (`t12.v1`), `OfferingMemorandumData` (`offering_memorandum.v1`), and `GenericDocumentData` (`facts.v1`) — are finalized against the extraction engine's real output. contact: name: Cactus API Support email: api@trycactus.com license: name: Proprietary — Cactus API License Agreement identifier: LicenseRef-Cactus-Partner-Agreement servers: - url: https://api.trycactus.com description: Production (live and sandbox keys) security: - apiKey: [] tags: - name: Documents description: Upload and manage documents via presigned URLs. - name: Extractions description: Structured data extraction jobs and results. - name: Underwritings description: Automated underwriting runs. - name: Usage description: Usage pool balance and metered activity. - name: Webhook Endpoints description: Manage endpoints that receive signed event notifications. paths: /v1/underwritings: post: tags: - Underwritings summary: Start an automated underwriting run description: | Kicks off the full automated underwriting workflow for a property. Documents are optional; when provided they are validated, accepted, and billed per the rate card, then ingested before the run starts. On completion, the notification email receives a signed link to the hosted financial-analysis report, and `underwriting.completed` is delivered to registered webhook endpoints. operationId: createUnderwriting parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UnderwritingCreateRequest' responses: '202': description: Run queued. headers: Request-Id: $ref: '#/components/headers/RequestId' content: application/json: schema: $ref: '#/components/schemas/Underwriting' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '422': description: Invalid property input or rejected documents. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '429': $ref: '#/components/responses/RateLimited' components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false schema: type: string maxLength: 255 description: Unique key making the request safely retryable. schemas: UnderwritingCreateRequest: type: object required: - property - notification_email properties: property: type: object required: - address - asset_class properties: address: type: object required: - line1 - city - state - postal_code properties: line1: type: string line2: type: string city: type: string state: type: string minLength: 2 maxLength: 2 postal_code: type: string asset_class: $ref: '#/components/schemas/AssetClass' notification_email: type: string format: email description: Receives the signed report link on completion. document_ids: type: array items: type: string description: Optional supporting documents (billed per rate card on acceptance). options: type: object properties: investment_strategy: type: string description: Strategy hint; defaults per asset class. Underwriting: type: object required: - id - object - status - created_at - sandbox properties: id: type: string example: uw_01J9ZK3M object: type: string const: underwriting status: $ref: '#/components/schemas/UnderwritingStatus' progress: type: object properties: phase: type: string detail: type: string property: type: object description: Echo of the submitted property. document_ids: type: array items: type: string billed_total_usd: type: string sandbox: type: boolean created_at: type: string format: date-time completed_at: type: string format: date-time report: type: object description: Present when completed. properties: url: type: string format: uri description: Signed, expiring link to the hosted financial-analysis report. expires_at: type: string format: date-time summary: type: object description: >- DRAFT — machine-readable headline results (key underwriting metrics). additionalProperties: true error: type: object properties: code: type: string message: type: string Problem: type: object description: RFC 9457 problem details. required: - title - status - code - request_id properties: type: type: string format: uri example: https://docs.trycactus.com/errors/document_over_size_cap title: type: string example: Document exceeds the size limit status: type: integer example: 422 detail: type: string example: Files over 500 pages or 100 MB are rejected and not charged. code: type: string description: Stable machine-readable error code. example: document_over_size_cap request_id: type: string errors: type: array description: Field-level validation errors, when applicable. items: type: object properties: field: type: string code: type: string message: type: string AssetClass: type: string enum: - multifamily - self-storage - industrial-outdoor-storage - commercial - industrial - office - retail - hotel UnderwritingStatus: type: string enum: - queued - ingesting - underwriting - calculating - completed - failed headers: RequestId: description: Unique request identifier; quote in support requests. schema: type: string responses: BadRequest: description: Malformed request. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Unauthorized: description: Missing, invalid, or revoked API key. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' RateLimited: description: Rate limit exceeded. headers: Retry-After: schema: type: integer description: Seconds to wait before retrying. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' securitySchemes: apiKey: type: http scheme: bearer bearerFormat: ck_live_* or ck_sandbox_* description: Partner API key issued by Cactus. ````