Residency Status

The Residency Status Answer is used to specify a customer's residential status, which is important for tax reporting, regulatory compliance, and risk assessment.

Fields

Field	Type	Required	Description
fieldTypeId	string	Yes	Must be set to "ResidencyStatus" (from FieldTypeEnum)
residencyStatusId	string	Yes	ID of the selected residency status

Example Usage

{
  "fqName": "PersonalInfo_Residency_Status",
  "answer": {
    "fieldTypeId": "ResidencyStatus",
    "residencyStatusId": "a640b5fd-0b98-494a-a6ec-6f7f8e323ff72"
  }
}

Lookup References

This answer model requires values from the following lookup source:

Residency Status Types: For valid values for the residencyStatusId field, please refer to the Lookup API documentation and use the "ResidentStatusEnum" lookup source.