Sign in

v1

latestOpenAPI 3.0.12026-08-06207388629.3 KB
PersonSocialSecurity

Returns single Social Security data by PersonId

get/v1/PersonSocialSecurity/{personId}

Path parameters

personIdinteger required

Response

The Social Security details

personIdinteger
overrideLifeExpectancyboolean
expectedAgeAtDeathinteger nullable
primaryInsuranceAmountnumber double
currentBenefitAmountnumber double nullable
benefitFirstReceivedDatestring date-time nullable
isAlreadyReceivingBenefitsboolean
ssdiBenefitAmountnumber double nullable
hasSsdiboolean
currentAnnualIncomenumber double
socialSecurityBenefitTypeID1 | 2 | 3 | 4 | 5 | 6 | 7 | 8
anticipatedBenefitAgeinteger
colaAssumptionnumber double
includeMedicareEstimatesboolean
exsDateOfBirthstring date-time nullable
exsPrimaryInsuranceAmountnumber double
deceasedDateOfBirthstring date-time nullable
deceasedPrimaryInsuranceAmountnumber double
spousalSurvivorBenefitAmountnumber double
hasBeenDivorcedboolean
hasBeenWidowedboolean
hasWorkedAsGovernmentEmployeeboolean