API ReferenceCertifications

Read Certification

Info for a specific certification

Path parameters

certificationIdstringRequired
The id of the certification

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.

Response

Expected response to a valid request
adjustedIncomeAmountdoubleOptional
Adjusted annual household income on the certification, in USD
anticipatedDatestringOptionalformat: "date"
The anticipated date for the certification, if applicable
applicationIdstringOptionalformat: "uuid"

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

assistancePaymentAmountdoubleOptional
The amount of assistance payment, in USD
certificationTypestringOptional

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

completionDatedatetimeOptional
Date the certification was completed
contractNumberstringOptional
HUD contract number tied to the certification floor plan
contractRentAmountdoubleOptional
The contract rent amount, in USD
createdAtdatetimeOptional
currentStatusstringOptional
Current status of the certification
customerSignatureDatestringOptionalformat: "date"
Date when the head of household signed the HUD 50059
customerSignatureSuccessbooleanOptional
Indicates whether all required resident signatures were collected
deletedAtdatetimeOptional
dueDatestringOptionalformat: "date"
Recertification due date for the certification
effectiveDatestringOptionalformat: "date"
The date when the certification becomes effective
eligibleHouseholdSizeintegerOptional
Eligible household size captured on the certification
floorPlananyOptional
floorPlanIdstringOptionalformat: "uuid"
grossRentAmountdoubleOptional
The gross rent amount, in USD
householdAssetsAmountdoubleOptional
Total value of household assets, in USD
householdIdstringOptionalformat: "uuid"
householdIncomeAmountdoubleOptional
Total annual income of the household, in USD
housingPolicyobjectOptional
housingPolicyIdstringOptionalformat: "uuid"
idstringOptionalformat: "uuid"
idempotencyIdstringOptionalformat: "uuid"
marketRentAmountdoubleOptional
The market rent amount, in USD
maxIncomeAmountdoubleOptional
Maximum allowable household income captured at certification completion, in USD
maxRentAmountdoubleOptional
Maximum allowable rent captured at certification completion, in USD
nextRecertificationDatestringOptionalformat: "date"
The next date for recertification, if applicable
numDependentsintegerOptional
Number of household members classified as dependents for the certification, per HUD definition
numEligibleMembersintegerOptional
Number of people in the household
organizationIdstringOptionalformat: "uuid"
ownerSignatureDatestringOptionalformat: "date"
Date when the owner or agent signed the HUD 50059
programstringOptional

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

propertyIdstringOptionalformat: "uuid"
readableIdstringOptional
reviewStatusenumOptional
The review status of the certification
secondarySubsidyTypestringOptional
Secondary HUD subsidy type configured on the property
subsidyTypeenumOptional
Type of subsidy for the certification
tenantNamestringOptional
Head of household name on the certification
tenantPaymentAmountdoubleOptional
The amount the tenant is required to pay, in USD
totalDeductionsAmountdoubleOptional
Total deductions amount, in USD
totalIncomeAmountdoubleOptional
Total annual household income on the certification, in USD
typeenumOptional
Type of certification according to their respective affordable program
uncountedHouseholdMembersintegerOptional
Number of adult members who reside in the unit but do not contribute financially and are not eligible for the subsidy
unitanyOptional
unitIdstringOptionalformat: "uuid"
unitNumberstringOptional
Unit number on the certification
updatedAtdatetimeOptional
utilityAllowanceAmountdoubleOptional
The utility allowance amount, in USD