Skip to content
API Documentation

Spousal Profile

Resource representing a user's spouse's personal information.

The Spousal Profile resource contains sensitive personal information about a user's spouse, including their identification details and occupation.

Endpoints

MethodUrl
GET/v1.0/users/:user_id/spousal-profile
PUT/v1.0/users/:user_id/spousal-profile
POST/v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-spousal-info
GET/v1.0/jobs/:job_id/spousal-profile

Properties

id
•
string

Unique identifier of the profile.

version
•
number

Version number of the profile. Any update increments this number.

owner_user_id
•
string

ID of the user that owns the profile.

create_time
•
string

Timestamp when the profile was created.

update_time
•
string

Timestamp when the profile was last updated.

occupation
•
string

The spouse's occupation.

personal_info
•
PersonalInfo

Object containing the spouse's personal information. See the personal info object.

Copied
1{
2  "id": "3b31f309-93ad-463a-ad1d-c39cac1c0a3d",
3  "version": 1,
4  "owner_user_id": "550e8400-e29b-41d4-a716-446655440000",
5  "create_time": "2024-01-01T00:00:00Z",
6  "update_time": "2024-01-01T00:00:00Z",
7  "occupation": "Teacher",
8  "personal_info": {
9    "first_name": "Jane",
10    "middle_initial": "M",
11    "last_name": "Doe",
12    "date_of_birth": "01/01/1991",
13    "personal_taxpayer_identification_number": "XXX-XX-6789"
14  }
15}

Personal Info

first_name
•
string
required

The spouse's first name.

middle_initial
•
string

The spouse's middle initial.

last_name
•
string
required

The spouse's last name.

date_of_birth
•
string

The spouse's date of birth (MM/DD/YYYY).

personal_taxpayer_identification_number
•
string

The spouse's SSN or ITIN. This value may be redacted when retrieving a profile.

Next steps

Last updated on December 9, 2024
Privacy PolicyTerms & Conditions© 2025 Taxfyle