List Application Requirements

GET

https://api.fortresstech.io/v1/applications/:applicationId/requirements

GET

/v1/applications/:applicationId/requirements

curl https://api.fortresstech.io/v1/applications/applicationId/requirements

[
  {
    "requirementId": "requirementId",
    "requirementType": "DOCUMENT",
    "documentTypeId": "documentTypeId",
    "formTemplateId": "formTemplateId",
    "verificationTypeKey": "verificationTypeKey",
    "applicantId": "applicantId",
    "requestedBy": "RULE",
    "status": "WAITING_ON_APPLICANT",
    "waitingReason": "NOT_UPLOADED",
    "uploadState": "NOT_UPLOADED",
    "currentDocumentId": "currentDocumentId",
    "requirementVersion": 1,
    "dueDate": "dueDate",
    "isOptional": true,
    "minQuantity": 1,
    "criteria": {
      "criteriaId": "criteriaId",
      "version": 1
    },
    "lastFinding": {
      "findingId": "findingId",
      "outcome": "APPROVE",
      "reasonCode": "reasonCode",
      "confidence": 1.1,
      "createdAt": "2024-01-15T09:30:00Z"
    }
  }
]

Available by Request

The requirement slots on the application: what is required, for whom, where each slot is in review, and the criteria row to review it against. Read on application.activated and whenever a requirement.* event tells you a slot changed. Returns [] when none. Pagination to be defined.

The application itself is read with GET /applications/{applicationId}; household members with GET /households/{householdId} and GET /customers filtered by household.

This endpoint is part of the document-review agent surface. To explore availability for your integration, please contact our team.

<Badge>Available by Request</Badge> The requirement slots on the application: what is required, for whom, where each slot is in review, and the criteria row to review it against. Read on `application.activated` and whenever a `requirement.*` event tells you a slot changed. Returns `[]` when none. Pagination to be defined. The application itself is read with `GET /applications/{applicationId}`; household members with `GET /households/{householdId}` and `GET /customers` filtered by household. <Note> This endpoint is part of the document-review agent surface. To explore availability for your integration, please contact our team. </Note>

Path parameters

applicationIdstringRequired

The id of the application

Response

The application's requirement slots

requirementIdstringOptionalformat: "uuid"

requirementTypeenumOptional

Fortress emits events and accepts findings for DOCUMENT slots only. FORM stays in the enum and emits nothing.

documentTypeIdstringOptionalformat: "uuid"

formTemplateIdstringOptionalformat: "uuid"

verificationTypeKeystringOptional

Set when requirementType is VERIFICATION.

applicantIdstringOptionalformat: "uuid"

Which member. null = household-level.

requestedByenumOptional

statusenumOptional

Status of one requirement slot. Never the status of the application or the document.

waitingReasonenumOptional

Why the applicant must act. Only set when status is WAITING_ON_APPLICANT.

uploadStateenumOptional

currentDocumentIdstringOptionalformat: "uuid"

requirementVersionintegerOptional

Send back on every write. Stale → 409.

dueDatestringOptionalformat: "date"

isOptionalbooleanOptional

minQuantityintegerOptional

criteriaobjectOptional

The ACTIVE criteria row for this slot. null when none authored yet — handle “no criteria”.

lastFindingobjectOptional

Errors

404

List Application Requirements Request Not Found Error