CORA API index

The routes CORA calls, in the order it needs them

Every route below lives in the main API Reference. This page is the CORA-shaped index: what to call, when, and where it is documented. All calls use the organization-scoped API key in the x-api-key header. requirementVersion is required on every requirement write. Configuration and cadence are read-only for agents.

Before acting on any event

RoutePurpose
GET /properties/{propertyId}/coraConfigurationIs CORA enabled for the property? Same contract as the Leslie configuration
GET /households/{householdId}/coraConfigurationIs CORA enabled for the household? Act on effectiveEnabled
GET /households/{householdId}/complianceReviewIs a Manual Compliance Review open? While OPEN, every write returns 409

Starting work on an application

RoutePurpose
GET /applications/{applicationId}The application record and its status
GET /households/{householdId} · GET /customers filtered by householdHousehold members and their applications
GET /applications/{applicationId}/requirementsThe requirement slots: status, waitingReason, uploadState, requirementVersion, criteria, lastFinding
GET /properties/{propertyId}/agents/cora/cadencePolicyThe outreach cadence to execute for the household

Reference data — cache it

RoutePurpose
GET /agentReviewReasonCodes · /{code}ESCALATION, REPLACEMENT and OVERRIDE codes; refresh on a new taxonomyVersion
GET /documentReviewCriteria · /{criteriaId}The rules a slot’s document is evaluated against; cache by (criteriaId, version)

Reviewing a document

RoutePurpose
GET /documents/{documentId}/downloadUrlShort-lived signed URL for the uploaded file
POST /applications/{applicationId}/requirements/{requirementId}/findingsThe one agent write. outcome is the slot transition
POST /applications/{applicationId}/correctionsAfter REQUEST_CORRECTION: apply permitted changes to application answers
POST /applications/{applicationId}/resignatureRequestsAfter a correction touches a field that must be re-signed
POST /applications/{applicationId}/requirements/{requirementId}/cancelCancel a slot — whether agents may is still open

Operating the agent

RoutePurpose
POST /properties/{propertyId}/agents/cora/alerts · GETRaise safety and operational alerts, e.g. STUCK_OR_FAILED_WORKFLOW

Not on the partner surface

Slot status transitions, enabling or disabling the agent, editing configuration or cadence, creating slots, re-running requirement rules, logging communications and opening site tasks are all Fortress-side. Events Fortress sends in return are listed on Events.