Read Certification

{
  "reviewStatus": "APPROVED",
  "effectiveDate": "2023-01-15",
  "anticipatedDate": "2023-01-15",
  "nextRecertificationDate": "2023-01-15",
  "contractNumber": "string",
  "type": "MOVE_IN",
  "certificationType": "string",
  "currentStatus": "string",
  "program": "string",
  "tenantName": "string",
  "unitNumber": "string",
  "dueDate": "2023-01-15",
  "completionDate": "2024-01-15T09:30:00Z",
  "subsidyType": "BMR_235",
  "secondarySubsidyType": "string",
  "tenantPaymentAmount": 1.1,
  "assistancePaymentAmount": 1.1,
  "utilityAllowanceAmount": 1.1,
  "marketRentAmount": 1.1,
  "grossRentAmount": 1.1,
  "contractRentAmount": 1.1,
  "maxRentAmount": 1.1,
  "maxIncomeAmount": 1.1,
  "ownerSignatureDate": "2023-01-15",
  "customerSignatureDate": "2023-01-15",
  "customerSignatureSuccess": true,
  "eligibleHouseholdSize": 1,
  "numEligibleMembers": 1,
  "numDependents": 1,
  "uncountedHouseholdMembers": 1,
  "householdIncomeAmount": 1.1,
  "totalIncomeAmount": 1.1,
  "adjustedIncomeAmount": 1.1,
  "householdAssetsAmount": 1.1,
  "totalDeductionsAmount": 1.1,
  "id": "string",
  "readableId": "string",
  "idempotencyId": "string",
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "deletedAt": "2024-01-15T09:30:00Z",
  "householdId": "string",
  "unitId": "string",
  "floorPlanId": "string",
  "propertyId": "string",
  "organizationId": "string",
  "housingPolicyId": "string",
  "applicationId": "string",
  "housingPolicy": {
    "name": "string",
    "type": "LURA",
    "contractNumber": "string",
    "subsidyType": "BMR_235",
    "geographicBoundaryWkt": "string",
    "fipsCode": "string",
    "effectiveStartDate": "2023-01-15",
    "effectiveEndDate": "2023-01-15",
    "id": "string",
    "readableId": "string",
    "idempotencyId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "housingProgramId": "string",
    "propertyId": "string"
  },
  "unit": {
    "number": "string",
    "floorLevel": "string",
    "isADA": true,
    "streetAddress1": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "fullAddress": "string",
    "status": "VACANT_READY",
    "isOccupied": true,
    "floorPlanId": "string",
    "propertyId": "string",
    "organizationId": "string",
    "buildingId": "string",
    "currentHouseholdId": "string",
    "lastMoveOutId": "string",
    "priorLeaseId": "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",
    "vacantSince": "2024-01-15T09:30:00Z",
    "reportOrder": 1.1,
    "makeReadyDate": "2023-01-15",
    "reportConfigurationValue": "Quoting Rent",
    "lastVacancyStartDate": "2023-01-15",
    "mostRecentApplicationId": "string"
  },
  "floorPlan": {
    "name": "string",
    "numBeds": 1,
    "numBaths": 1,
    "numHalfBaths": 1,
    "isAffordable": true,
    "isCommercial": true,
    "grossSqFt": 1200,
    "rentableSqFt": 1100,
    "marketingName": "string",
    "marketingDesc": "string",
    "baseMarketRentAmount": 1200.5,
    "quotingRentAmount": 1200.5,
    "financialMarketRentAmount": 1200.5,
    "hudGrossRent": 1.1,
    "grossRentLimit": 1.1,
    "maxRentPercent": 1.1,
    "utilityAllowancesSum": 1.1,
    "nonOptionalChargeSum": 1.1,
    "avgLeasedRent": 1.1,
    "propertyId": "string",
    "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"
  }
}

Info for a specific certification

Authentication

x-api-keystring

API Key authentication via header

Path parameters

certificationIdstringRequired

The id of the certification

Response

Expected response to a valid request

reviewStatusenumOptional

The review status of the certification

effectiveDatedateOptional

The date when the certification becomes effective

anticipatedDatedateOptional

The anticipated date for the certification, if applicable

nextRecertificationDatedateOptional

The next date for recertification, if applicable

contractNumberstringOptional

HUD contract number tied to the certification floor plan

typeenumOptional

Type of certification according to their respective affordable program

certificationTypestringOptional

Raw certification type as stored on the certification (e.g. RECERT, GROSS_RENT, MI, IR, AR)

currentStatusstringOptional

Current status of the certification

programstringOptional

Affordable program name of the certification (e.g. HUD, Tax Credit, Rural Development)

tenantNamestringOptional

Head of household name on the certification

unitNumberstringOptional

Unit number on the certification

dueDatedateOptional

Recertification due date for the certification

completionDatedatetimeOptional

Date the certification was completed

subsidyTypeenumOptional

Type of subsidy for the certification

Allowed values:

secondarySubsidyTypestringOptional

Secondary HUD subsidy type configured on the property

tenantPaymentAmountdoubleOptional

The amount the tenant is required to pay, in USD

assistancePaymentAmountdoubleOptional

The amount of assistance payment, in USD

utilityAllowanceAmountdoubleOptional

The utility allowance amount, in USD

marketRentAmountdoubleOptional

The market rent amount, in USD

grossRentAmountdoubleOptional

The gross rent amount, in USD

contractRentAmountdoubleOptional

The contract rent amount, in USD

maxRentAmountdoubleOptional

Maximum allowable rent captured at certification completion, in USD

maxIncomeAmountdoubleOptional

Maximum allowable household income captured at certification completion, in USD

ownerSignatureDatedateOptional

Date when the owner or agent signed the HUD 50059

customerSignatureDatedateOptional

Date when the head of household signed the HUD 50059

customerSignatureSuccessbooleanOptional

Indicates whether all required resident signatures were collected

eligibleHouseholdSizeintegerOptional

Eligible household size captured on the certification

numEligibleMembersintegerOptional

Number of people in the household

numDependentsintegerOptional

Number of household members classified as dependents for the certification, per HUD definition

uncountedHouseholdMembersintegerOptional

Number of adult members who reside in the unit but do not contribute financially and are not eligible for the subsidy

householdIncomeAmountdoubleOptional

Total annual income of the household, in USD

totalIncomeAmountdoubleOptional

Total annual household income on the certification, in USD

adjustedIncomeAmountdoubleOptional

Adjusted annual household income on the certification, in USD

householdAssetsAmountdoubleOptional

Total value of household assets, in USD

totalDeductionsAmountdoubleOptional

Total deductions amount, in USD

idstringOptionalformat: "uuid"

readableIdstringOptional

idempotencyIdstringOptionalformat: "uuid"

createdAtdatetimeOptional

updatedAtdatetimeOptional

deletedAtdatetimeOptional

householdIdstringOptionalformat: "uuid"

unitIdstringOptionalformat: "uuid"

floorPlanIdstringOptionalformat: "uuid"

propertyIdstringOptionalformat: "uuid"

organizationIdstringOptionalformat: "uuid"

housingPolicyIdstringOptionalformat: "uuid"

applicationIdstringOptionalformat: "uuid"

The ID of the application associated with this certification (for INITIAL certs)

housingPolicyobjectOptional

unitobjectOptional

floorPlanobjectOptional