Skip to content

API Documentation

ConceptsThe Worklayer platformAuthentication

MemberThe Member ResourceCreate a memberRetrieve a list of membersUpdate a member

JobsThe Job ResourceThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProSubmit a jobRetrieve a list of your jobsList job documentsRetrieve a job url - DEPRECATEDDelete a jobRetrieve a job checklistComplete info gathering for a job

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeList consultation service itemsCreate job scope change requestApprove a job scope changeReject a job scope change

Job TemplatesThe Job Template ResourceRetrieve available job templates

Service PackagesThe Service Package ResourceRetrieve a list of your service packagesSubmit service package answers

Personal ProfilesThe Personal Profile ResourceRetrieve a personal profileSave a personal profileProvide a personal profile to a jobRetrieve a personal profile for a job

Spousal ProfilesThe Spousal Profile ResourceRetrieve a spousal profileSave a spousal profileProvide a spousal profile to a jobRetrieve a spousal profile for a job

Dependent ProfilesThe Dependent Profile ResourceRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodProvide a personal refund methodProvide a business refund method

DocumentsThe Document ResourceCreate a documentGet a documentDownload a document

Document TypesThe Document Type ResourceList document types

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

Retrieve a spousal profile

Retrieve a user's spousal profile information.

This endpoint retrieves the latest version of the spousal profile for a specific user. It includes sensitive personal data.

Endpoint

Method	Url
`GET`	`/v1.0/users/:user_id/spousal-profile`

Path Parameters

user_id

•

string

required

The unique identifier of the user whose spousal profile is being retrieved.

Sample Request

Copied
1curl -X GET 'https://api.worklayer.com/v1.0/users/3b31f309-93ad-463a-ad1d-c39cac1c0a3d/spousal-profile' \
2-H 'Authorization: Bearer {token}'

Response

Returns a spousal profile.

Sample Response

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}

Errors

404: the user does not yet have a spousal profile
403: you're not allowed to retrieve the profile

Next steps

Save a spousal profile

Last updated on December 9, 2024

Privacy Policy Terms & Conditions© 2025 Taxfyle