Create Document

curl -X POST https://api.fortresstech.io/v1/households/householdId/documents \
     -H "Content-Type: multipart/form-data" \
     -F file=@<file1> \
     -F idempotencyId="idempotencyId" \
     -F createdById="createdById"

{
  "householdId": "householdId",
  "id": "id",
  "propertyId": "propertyId",
  "url": "url",
  "createdAt": "2024-01-15T09:30:00Z",
  "createdByUserId": "createdByUserId",
  "deletedAt": "2024-01-15T09:30:00Z",
  "household": {
    "status": "APPLICANT",
    "isUnderEviction": true,
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "currentUnitId": "currentUnitId",
    "currentLeaseId": "currentLeaseId",
    "applicationId": "applicationId",
    "organizationId": "organizationId",
    "propertyId": "propertyId",
    "currentCertificationId": "currentCertificationId",
    "prospectId": "prospectId",
    "primaryCustomerId": "primaryCustomerId",
    "totalActiveRentAmount": 1.1,
    "totalActiveSubsidyAmount": 1.1,
    "totalActiveFeesAmount": 1.1,
    "unitId": "unitId"
  },
  "idempotencyId": "idempotencyId",
  "isReviewed": true,
  "mimeType": "mimeType",
  "name": "name",
  "notes": "notes",
  "organizationId": "organizationId",
  "property": {
    "name": "name",
    "shortName": "shortName",
    "email": "email",
    "phone": "phone",
    "physicalStreetAddress1": "physicalStreetAddress1",
    "physicalStreetAddress2": "physicalStreetAddress2",
    "physicalCity": "physicalCity",
    "physicalState": "physicalState",
    "physicalZip": "physicalZip",
    "physicalCountry": "physicalCountry",
    "mailingStreetAddress1": "mailingStreetAddress1",
    "mailingStreetAddress2": "mailingStreetAddress2",
    "mailingCity": "mailingCity",
    "mailingState": "mailingState",
    "mailingZip": "mailingZip",
    "mailingCountry": "mailingCountry",
    "phoneNumber": "phoneNumber",
    "faxNumber": "faxNumber",
    "timezone": "timezone",
    "longitude": 1.1,
    "latitude": 1.1,
    "turnMoveOutDays": 1,
    "status": "ACTIVE",
    "propertyClass": "Conventional",
    "organizationId": "organizationId",
    "id": "id",
    "readableId": "readableId",
    "idempotencyId": "idempotencyId",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "offboardedAt": "2024-01-15T09:30:00Z",
    "countyName": "countyName",
    "acquisitionDate": "2024-01-15T09:30:00Z"
  },
  "readableId": "readableId",
  "type": "type",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Available by Request

Creates a document for a specific household

This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team.

<Badge>Available by Request</Badge> Creates a document for a specific household <Note> This endpoint is part of our evolving API ecosystem. To explore availability for your integration, please contact our team. </Note>

Path parameters

householdIdstringRequired

The id of the household

Request

This endpoint expects a multipart form containing a file.

filefileRequired

The file to upload (max 5MB). Supported formats - image/jpeg, image/png, image/gif, application/pdf

idempotencyIdstringRequiredformat: "uuid"

Unique identifier to ensure idempotent operations

createdByIdstringRequiredformat: "uuid"

The ID of the user who created the attachment

namestringOptional<=255 characters

The name of the document. If not provided, the filename will be used

documentTypeenumOptionalDefaults to Miscellaneous

The type of document being uploaded

Allowed values:

Response

The created document

householdIdstringformat: "uuid"

idstringformat: "uuid"

propertyIdstringformat: "uuid"

urlstring

createdAtdatetimeOptional

createdByUserIdstringOptionalformat: "uuid"

deletedAtdatetimeOptional

householdobjectOptional

idempotencyIdstringOptionalformat: "uuid"

isReviewedbooleanOptionalDefaults to false

Indicates if the document has been reviewed by compliance

mimeTypestringOptional

namestringOptional

notesstringOptional

organizationIdstringOptionalformat: "uuid"

propertyobjectOptional

readableIdstringOptional

typestringOptional

updatedAtdatetimeOptional