Direct Integration API icon

Direct Integration API

(0 reviews)

Household Dependant

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "Household": [{
                    "Dependant": [{
                        "@Age": "99",
                        "@DateOfBirth": "2023-02-08",
                        "@Name: "John Doe",
                        "@UniqueID": "eb4f68665745"
                    }],
                    "@Name": "Abbott Household",
                    "@NumberOfAdults": "1",
                    "@NumberOfDependants": "1",
                    "@SequenceNumber": "0",
                    "@UniqueID": "fa86c8054f4c"
                }]
            }
        }
    }
}

Detailed description of each field:
Field NameDescriptionTypePathRequiredEnumerationsNote
HouseholdA household to which one or more person applicants belong, used in relation to the calculation of household living expensesarrayPackage.Content.Application.Household
DependantA person who depends on the applicant(s) for financial or other supportarrayPackage.Content.Application.Household.Dependant
@AgeThe age of the dependant at the time of submitting the applicationintegerPackage.Content.Application.Household.Dependant.Age
@DateOfBirthThe dependant's date of birthstringPackage.Content.Application.Household.Dependant.DateOfBirthYes, if "no of dependants" is not zero
@NameThe name of the dependantstringPackage.Content.Application.Household.Dependant.Name
@UniqueIDUnique Identifier for this Dependant ElementstringPackage.Content.Application.Household.Dependant.UniqueIDYes, if "no of dependants" is not zero

Reviews