Skip to content

Create Dependent Profile

Create a new dependent profile for a user.

This endpoint creates a new dependent profile for a specific user. It allows setting sensitive personal data and the relationship to the user.

Endpoint

MethodUrl
POST/v1.0/dependent-profiles

Path Parameters

user_id
string
required

The unique identifier of the user for whom to create the dependent profile.

Request Body

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' \
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 created profile.

version
integer

Version number of the created profile (will be 1).

Sample Response

Copied
1{
2 "id": "550e8400-e29b-41d4-a716-446655440000",
3 "version": 1
4}

Errors

  • 400: invalid request body
  • 403: you're not allowed to create the profile
Last updated on December 9, 2024