Create Dependents
/unified/hris/dependents
Query Parameters
Refer Specifying query parameters in Truto APIs
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount). When the upstream body exceeds 1 MiB,datais replaced by{ truto_truncated: true, truto_max_bytes, truto_excerpt }.debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
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.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
YYYY-MM-DD
1 supported
The employee (employees.id) the dependent belongs to.
1 supported1 required
The unique identifier for employees
The name of the employee
The first name of the dependent
1 supported
BambooHR accepts male or female. Other values are not sent.
malefemalenon_binaryotherprefer_not_to_disclosemalefemale
1 supported
malefemaleThe 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.
1 supported
The city of the home address
The country of the home address
The unique identifier for locations
This represents the name of the location
The postal code of the home address
The state/province of the home address
The first line of home address
The second line of home address
Whether the dependent is a full-time student
1 supported
The last name of the dependent
1 supported
The middle name of the dependent
1 supported
The first phone number is stored as the dependent's home phone.
1 supported
The extension of the phone number
The phone number
The type of phone number
BambooHR accepts spouse, domestic_partner, child, stepchild and foster_child. Other values are not sent.
spousedomestic_partnerchildstepchildfoster_childwardparentotherspousedomestic_partnerchildstepchildfoster_child+ 1 more
1 supported
spousedomestic_partnerchildstepchildfoster_childAny 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.
The dependent's SSN in plain text; BambooHR stores it encrypted and returns it masked.
1 supported
Response Body
The unique identifier for the dependent
1 supported
The date and time the dependent was created
The date of birth of the dependent, in YYYY-MM-DD format. Empty when the provider masks it.
1 supported
The email addresses of the dependent
The email address
Whether the email address is primary
The type of email address
The employee the dependent belongs to
1 supported
The unique identifier for employees
The name of the employee
When the person stopped being a dependent of the employee. Empty while they still are
The first name of the dependent
1 supported
The gender of the dependent. Empty when the provider value fits none of these.
malefemalenon_binaryotherprefer_not_to_disclose
1 supported
The home addresses of the dependent. Most providers record a single address.
1 supported
The city of the home address
The country of the home address
The unique identifier for locations
This represents the name of the location
The postal code of the home address
The state/province of the home address
The first line of home address
The second line of home address
Whether the dependent has a disability
Whether the dependent is a full-time student
1 supported
Whether the dependent uses tobacco
The last name of the dependent
1 supported
The middle name of the dependent
1 supported
The full name of the dependent
1 supported
The phone numbers of the dependent
1 supported
The extension of the phone number
The phone number
The type of phone number
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.
spousedomestic_partnerchildstepchildfoster_childwardparentother
1 supported
Raw data returned from the remote API call.
The social security number or national identifier of the dependent. Most providers return it masked.
1 supported
When the person became a dependent of the employee, such as the relationship or coverage eligibility start date
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.
activeinactive
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 jsonimport 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())