Skip to content
POST /unified/hris/dependents

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). When the upstream body exceeds 1 MiB, data is replaced by { truto_truncated: true, truto_max_bytes, truto_excerpt }. debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

date_of_birthstring

YYYY-MM-DD

1 supported
BambooHR
supported
employeeobject

The employee (employees.id) the dependent belongs to.

References: Employees → id
1 supported1 required
BambooHR
required
idstring

The unique identifier for employees

namestring

The name of the employee

first_namestring

The first name of the dependent

1 supported
BambooHR
supported
genderstring

BambooHR accepts male or female. Other values are not sent.

Possible values:
malefemalenon_binaryotherprefer_not_to_disclosemalefemale
1 supported
BambooHR
supported
malefemale
home_locationobject[]

The dependent's home addresses. BambooHR stores one address, so only the first entry is sent. state must be a 2-letter code and country an ISO 3166-1 alpha-2 code.

References: Locations → id
1 supported
BambooHR
supported
citystring

The city of the home address

countrystring

The country of the home address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the home address

statestring

The state/province of the home address

street_1string

The first line of home address

street_2string

The second line of home address

is_studentboolean

Whether the dependent is a full-time student

1 supported
BambooHR
supported
last_namestring

The last name of the dependent

1 supported
BambooHR
supported
middle_namestring

The middle name of the dependent

1 supported
BambooHR
supported
phonesobject[]

The first phone number is stored as the dependent's home phone.

1 supported
BambooHR
supported
extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

relationshipstring

BambooHR accepts spouse, domestic_partner, child, stepchild and foster_child. Other values are not sent.

Possible values:
spousedomestic_partnerchildstepchildfoster_childwardparentotherspousedomestic_partnerchildstepchild+ 1 more
1 supported
BambooHR
supported
spousedomestic_partnerchildstepchildfoster_child
remote_dataRecord<string, any>

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

ssnstring

The dependent's SSN in plain text; BambooHR stores it encrypted and returns it masked.

1 supported
BambooHR
supported

Response Body

idstring
required·

The unique identifier for the dependent

1 supported
BambooHR
supported
created_atstring · date-time

The date and time the dependent was created

date_of_birthstring

The date of birth of the dependent, in YYYY-MM-DD format. Empty when the provider masks it.

1 supported
BambooHR
supported
emailsobject[]

The email addresses of the dependent

emailstring

The email address

is_primaryboolean

Whether the email address is primary

typestring

The type of email address

employeeobject

The employee the dependent belongs to

References: Employees → id
1 supported
BambooHR
supported
idstring

The unique identifier for employees

namestring

The name of the employee

end_datestring · date-time

When the person stopped being a dependent of the employee. Empty while they still are

first_namestring

The first name of the dependent

1 supported
BambooHR
supported
genderstring

The gender of the dependent. Empty when the provider value fits none of these.

Possible values:
malefemalenon_binaryotherprefer_not_to_disclose
1 supported
BambooHR
supported
home_locationobject[]

The home addresses of the dependent. Most providers record a single address.

References: Locations → id
1 supported
BambooHR
supported
citystring

The city of the home address

countrystring

The country of the home address

idstring

The unique identifier for locations

namestring

This represents the name of the location

postal_codestring

The postal code of the home address

statestring

The state/province of the home address

street_1string

The first line of home address

street_2string

The second line of home address

is_disabledboolean

Whether the dependent has a disability

is_studentboolean

Whether the dependent is a full-time student

1 supported
BambooHR
supported
is_tobacco_userboolean

Whether the dependent uses tobacco

last_namestring

The last name of the dependent

1 supported
BambooHR
supported
middle_namestring

The middle name of the dependent

1 supported
BambooHR
supported
namestring

The full name of the dependent

1 supported
BambooHR
supported
phonesobject[]

The phone numbers of the dependent

1 supported
BambooHR
supported
extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The type of phone number

relationshipstring

The dependent's relationship to the employee. Relationships that fit none of the other values, such as grandchild or legal guardian, are returned as other, and the provider's own label stays in remote_data. Registered or civil partnerships that the provider records separately from marriage are returned as domestic_partner.

Possible values:
spousedomestic_partnerchildstepchildfoster_childwardparentother
1 supported
BambooHR
supported
remote_dataRecord<string, any>

Raw data returned from the remote API call.

ssnstring

The social security number or national identifier of the dependent. Most providers return it masked.

1 supported
BambooHR
supported
start_datestring · date-time

When the person became a dependent of the employee, such as the relationship or coverage eligibility start date

statusstring

Whether the person is currently a dependent of the employee. inactive means they no longer are, for example after being removed from coverage. Empty when the provider does not say.

Possible values:
activeinactive
updated_atstring · date-time

The date and time the dependent was last updated

truto unified hris dependents \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "employee": {},
  "first_name": "your_first_name",
  "middle_name": "your_middle_name",
  "last_name": "your_last_name",
  "relationship": "spouse",
  "gender": "male",
  "date_of_birth": "your_date_of_birth",
  "ssn": "your_ssn",
  "is_student": true,
  "home_location": [],
  "phones": [],
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.create(
  'hris',
  'dependents',
  {
  "employee": {},
  "first_name": "your_first_name",
  "middle_name": "your_middle_name",
  "last_name": "your_last_name",
  "relationship": "spouse",
  "gender": "male",
  "date_of_birth": "your_date_of_birth",
  "ssn": "your_ssn",
  "is_student": true,
  "home_location": [],
  "phones": [],
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.create(
        "hris",
        "dependents",
        {
        "employee": {},
        "first_name": "your_first_name",
        "middle_name": "your_middle_name",
        "last_name": "your_last_name",
        "relationship": "spouse",
        "gender": "male",
        "date_of_birth": "your_date_of_birth",
        "ssn": "your_ssn",
        "is_student": True,
        "home_location": [],
        "phones": [],
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X POST 'https://api.truto.one/unified/hris/dependents?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "employee": {},
  "first_name": "your_first_name",
  "middle_name": "your_middle_name",
  "last_name": "your_last_name",
  "relationship": "spouse",
  "gender": "male",
  "date_of_birth": "your_date_of_birth",
  "ssn": "your_ssn",
  "is_student": true,
  "home_location": [],
  "phones": [],
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "employee": {},
  "first_name": "your_first_name",
  "middle_name": "your_middle_name",
  "last_name": "your_last_name",
  "relationship": "spouse",
  "gender": "male",
  "date_of_birth": "your_date_of_birth",
  "ssn": "your_ssn",
  "is_student": true,
  "home_location": [],
  "phones": [],
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/hris/dependents?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/hris/dependents"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "employee": {},
    "first_name": "your_first_name",
    "middle_name": "your_middle_name",
    "last_name": "your_last_name",
    "relationship": "spouse",
    "gender": "male",
    "date_of_birth": "your_date_of_birth",
    "ssn": "your_ssn",
    "is_student": True,
    "home_location": [],
    "phones": [],
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())