Create Document

POST

https://api.fortresstech.io/v1/households/:householdId/documents

POST

/v1/households/:householdId/documents

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

200Successful

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

Authentication

x-api-keystring

API Key authentication via header

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

urlstring

idstringformat: "uuid"

householdIdstringformat: "uuid"

propertyIdstringformat: "uuid"

namestringOptional

typestringOptional

mimeTypestringOptional

notesstringOptional

isReviewedbooleanOptionalDefaults to false

Indicates if the document has been reviewed by compliance

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

organizationIdstringOptionalformat: "uuid"

createdByUserIdstringOptionalformat: "uuid"

householdobjectOptional

propertyobjectOptional