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

Update Dependent Profile

Update an existing dependent profile.

This endpoint updates an existing dependent profile. It allows modifying sensitive personal data and the relationship to the user.

Please note that all properties are replaced with the values from the request payload. If a property is not specified, it will be replaced with an empty value.

Any change results in a new version.

Endpoint

Method	Url
`POST`	`/v1.0/dependent-profiles/:dependent_profile_id`

Path Parameters

user_id

•

string

required

The unique identifier of the user who owns the dependent profile.

dependent_profile_id

•

string

required

The unique identifier of the dependent profile to update.

Request Body

Warning

All properties in the request will completely replace the existing values. If a property is omitted from the request, its value will be set to null. To maintain existing values, you must include them in the request.

relationship

•

string

required

The dependent's relationship to the user.

personal_info

•

object

required

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

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/users/3b31f309-93ad-463a-ad1d-c39cac1c0a3d/dependent-profiles/e7b513b9-d795-4475-9382-96710ca61622' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{
5  "relationship": "Child",
6  "personal_info": {
7    "first_name": "Alice",
8    "last_name": "Doe",
9    "date_of_birth": "01/01/2010"
10  }
11}'

Response

id

•

string

Unique identifier of the updated profile.

version

•

integer

New version number of the updated profile.

Sample Response

Copied
1{
2  "id": "e7b513b9-d795-4475-9382-96710ca61622",
3  "version": 2
4}

Errors

400: invalid request body
403: you're not allowed to update the profile
404: the dependent profile was not found

Next steps

Provide a dependent profile to a job

Last updated on December 9, 2024

Privacy Policy Terms & Conditions© 2025 Taxfyle