Read the document type definitions

GET

https://api.fortresstech.io/v1/compliance-documents/manifest

GET

/v1/compliance-documents/manifest

curl https://api.fortresstech.io/v1/compliance-documents/manifest \
     -H "x-api-key: <apiKey>"

[
  {
    "documentTypeId": "3b929155-899e-5fcf-ae13-c1f3ccab66ca",
    "documentTypeKey": "employment_pay_stub",
    "label": "Employment: Upload Pay stubs",
    "definitionVersion": "1.0",
    "definitionStatus": "approved",
    "fields": [
      {
        "canonicalName": "income.person.full_name",
        "label": "Employee Full Name",
        "dataType": "string",
        "required": true,
        "allowedValues": null,
        "instruction": "The employee's full legal name exactly as printed, usually in the top employee/earnings-statement block near the address. Include middle name and suffix if shown. Do not return the employer name."
      },
      {
        "canonicalName": "income.period.pay_date",
        "label": "Pay Date",
        "dataType": "date",
        "required": true,
        "allowedValues": null,
        "instruction": "The date the employee was actually paid, may be labeled Pay Date / Check Date / Deposit Date / Date Issued / Payment Date / Date of Payment. Reformat to YYYY-MM-DD. If both appear, this is the check/deposit date, separate from period end."
      },
      {
        "canonicalName": "income.period.frequency",
        "label": "Pay Frequency",
        "dataType": "string",
        "required": false,
        "allowedValues": [
          "daily",
          "weekly",
          "biweekly",
          "semi-monthly",
          "monthly"
        ],
        "instruction": "The pay cadence stated on the stub, normalized to exactly one of: daily, weekly, biweekly, semi-monthly, monthly. Only return if explicitly stated; do not infer from period length; else null."
      }
    ],
    "mappings": [
      {
        "mappingId": "M1",
        "documentValue": "income.person.full_name",
        "applicationSource": "applicants[].customer → firstName, middleName, lastName, suffix (adults); applicants[].minor → firstName, middleName, lastName, suffix (minors); applicants[].id is the bundle requirement's applicantId",
        "status": "active"
      },
      {
        "mappingId": "M4",
        "documentValue": "income.period.frequency",
        "applicationSource": "applicants[].incomes[] where type = JOB and payComponent = BASE_PAY → payFrequency",
        "status": "active"
      }
    ],
    "rules": [
      {
        "ruleId": "I.1",
        "name": "Legibility",
        "checkType": "ai_judgement",
        "ruleType": "standard",
        "checksAcross": "household",
        "onFail": "reupload",
        "evaluator": "cora",
        "status": "active",
        "description": "Document is legible- nothing is cut off or blurry",
        "program": "All",
        "inputs": [],
        "applicantMessage": "Looks like {document} is blurry/cut off. Can you please upload a clear version of this document with nothing cut off?",
        "reviewerMessage": null
      },
      {
        "ruleId": "I.4",
        "name": "Gross = Net + Deductions",
        "checkType": "exact",
        "ruleType": "fraud",
        "checksAcross": "this_document",
        "onFail": "compliance_only",
        "evaluator": "cora",
        "status": "active",
        "description": "Current gross pay equals current net pay plus current total deductions",
        "program": "All",
        "expression": "abs(income.current.gross_pay - (income.current.net_pay + income.current.total_deductions)) <= 1.00",
        "inputs": [
          "income.current.gross_pay",
          "income.current.net_pay",
          "income.current.total_deductions"
        ],
        "applicantMessage": "CORA is digging deeper",
        "reviewerMessage": null
      },
      {
        "ruleId": "I.7",
        "name": "Pay period is recent",
        "checkType": "exact",
        "ruleType": "standard",
        "checksAcross": "this_document",
        "onFail": "reupload",
        "evaluator": "cora",
        "status": "active",
        "description": "The pay period end date is within 120 days of the certification effective date.",
        "program": "All",
        "expression": "within_days(income.period.end_date, application.certification_effective_date, 120)",
        "inputs": [
          "income.period.end_date",
          "application.certification_effective_date"
        ],
        "applicantMessage": "Please upload a recent pay stub. The one we have is more than 120 days old.",
        "reviewerMessage": null
      }
    ],
    "taxonomyDomain": "Income",
    "recognition": "An earnings statement issued by an employer for a specific pay period. Shows the employee and employer names, pay period and/or pay date, current and year-to-date gross pay, deductions and net pay. May be a paper check stub or a direct-deposit advice."
  },
  {
    "documentTypeId": "9d74c315-593a-581a-8739-a3783de916f3",
    "documentTypeKey": "identity_social_security_card",
    "label": "Identity Verification: Upload Social Security Card",
    "definitionVersion": "1.0",
    "definitionStatus": "in_review",
    "fields": [
      {
        "canonicalName": "identity.ssn_card.name_on_card",
        "label": "Name on Card",
        "dataType": "string",
        "required": true,
        "allowedValues": null,
        "instruction": "The name printed on the card. Return as printed."
      },
      {
        "canonicalName": "identity.ssn_card.card_restriction",
        "label": "Card Restriction",
        "dataType": "string",
        "required": false,
        "allowedValues": [
          "none",
          "not_valid_for_employment",
          "valid_with_dhs_authorization"
        ],
        "instruction": "Any restriction printed on the card. Return one listed word."
      }
    ],
    "mappings": [],
    "rules": [
      {
        "ruleId": "I.1",
        "name": "Legibility",
        "checkType": "ai_judgement",
        "ruleType": "standard",
        "checksAcross": "household",
        "onFail": "reupload",
        "evaluator": "cora",
        "status": "active",
        "description": "Document is legible- nothing is cut off or blurry",
        "program": "All",
        "inputs": [],
        "applicantMessage": "Looks like {document} is blurry/cut off. Can you please upload a clear version of this document with nothing cut off?",
        "reviewerMessage": null
      },
      {
        "ruleId": "C.2",
        "name": "Name matches a household member",
        "checkType": "ai_judgement",
        "ruleType": "standard",
        "checksAcross": "household",
        "onFail": "clarification",
        "evaluator": "cora",
        "status": "active",
        "description": "The name on the document matches a household member on the application. Allow middle names, maiden or married names, nicknames, suffixes, more than one surname, and different name order. If the only difference is a last name change (for example after marriage or divorce), ask about it. Look at the application and the household's other uploaded documents. Ask only if it is not accounted for in either.",
        "program": "All",
        "inputs": [],
        "applicantMessage": "The name on your Social Security card is different from the name on your application. Please explain, for example a name change after marriage or divorce.",
        "reviewerMessage": null
      },
      {
        "ruleId": "C.5",
        "name": "Card restriction",
        "checkType": "exact",
        "ruleType": "standard",
        "checksAcross": "this_document",
        "onFail": "note",
        "evaluator": "cora",
        "status": "active",
        "description": "If Card Restriction is not none, note it for the reviewer.",
        "program": "All",
        "inputs": [],
        "applicantMessage": null,
        "reviewerMessage": null
      }
    ],
    "taxonomyDomain": "Identity & Composition",
    "recognition": "A Social Security card issued by the U.S. Social Security Administration, showing the person's name and Social Security number. Some cards say 'Not valid for employment' or 'Valid for work only with DHS authorization'. A letter from Social Security showing the number may also be uploaded here. For a newborn, proof the number was applied for may be uploaded until the card arrives. No expiration date."
  }
]

Every document type CORA handles, each with its current definition (fields, mappings, rules), independent of any application or upload. CORA reads it before any upload to build and review one Blueprint per document type and definitionVersion.

The manifest and the application bundle share documentTypeId, documentTypeKey and the definition objects (DefinitionField, DefinitionMapping, DefinitionRule). For a given documentTypeId and definitionVersion, the bundle (with include) returns the definition this route returned for that version. One version per document type. Any change to an approved definition is a new definitionVersion. A definition that is not approved can change without a new version; the bundle serves it as definitionVersion: null. This route returns only the current version. The bundle serves the current definition version for each document type. The version can change during an application when a definition is updated; compare definitionVersion to pick the Blueprint; a definitionVersion with no Blueprint: re-read the manifest. A document type with no approved definition has definitionVersion: null. Fortress tells Fission Labs when a definition changes. There is no event for it.

The response is a JSON array, one element per document type, with no envelope. The route takes no parameters.

The API key needs the compliance-documents: read permission.

Authenticate with the x-api-key header.

Authentication

x-api-keystring

API Key authentication via header

Response

Every document type with its current definition.

documentTypeIdstringformat: "uuid"

Fortress ID of the document type. Same value as in the bundle.

documentTypeKeystring

Stable key of the document type. Referenced by the authoring template and Fission's compiled definitions.

labelstring

definitionVersionstring

Current version of the definition. The bundle serves the current definition version for each document type. The version can change during an application when a definition is updated; compare definitionVersion to pick the Blueprint; a definitionVersion with no Blueprint: re-read the manifest. A document type with no approved definition has definitionVersion: null.

definitionStatusenum

Authoring status of this definitionVersion (authoring template, tab 1). Fortress is still aligning with Fission Labs (CORA) on which statuses the bundle serves.

Allowed values:

fieldslist of objects

mappingslist of objects

ruleslist of objects

taxonomyDomainstringOptional

recognitionstringOptional

How to recognize this document type.

Errors

401

Unauthorized Error

403

Forbidden Error