# Add Dependent v2.0Beta
The Add Dependent endpoint adds a dependent to an existing customer profile. Values supplied will be validated against a set of basic validation rules and applied to the customer profile. The new dependent will reflect immediately on the customer profile.
To qualify to be added as a dependent, the dependent must be less than 18 years of age.
In addition, a customer may only add 4 dependents via self service channels. Our contact centre may add additional dependents as required. The Customer resource contains a dependentLimitReached property to check if the customer may add more dependents.
# Request
# Authorization
An OAuth 2.0 Bearer token with the Profile.Write scope is required. For more information, see Authentication.
# Path Parameters
A list of the supported path parameters is described below.
| Name | Required | Type | Description |
|---|---|---|---|
| profileKey | true | guid | The profile key for the customer. This value can be retrieved from the profileKey claim in the token returned from our SSO solution. |
# Request Body
The request body takes an AddDependent object which is described below.
# AddDependent
| Name | Required | Type | Description |
|---|---|---|---|
| firstName | true | string(50) | The first name of the dependent. |
| lastName | true | string(50) | The last name of the dependent. |
| birthDate | true | date | The birth date of the dependent. The dependent must be less than 18 years of age and the birth date must not be in the future. |
| gender | false | string | The gender for the customer. Must either be a valid value from the genders lookup or unspecified if the customer does not wish to specify their gender. |
| homeLanguage | false | string | The home language for the customer. Must either be a valid value from the home languages lookup or unspecified. |
# Sample
{
"firstName": "Abigail",
"lastName": "Jones",
"birthDate": "2019-01-04T00:00:00",
"gender": "Female",
"homeLanguage": "English"
}
# Response
# Response Body
The endpoint returns our ApiResponse envelope.
# Sample
{
"message": "The operation succeeded!",
"notifications": [
{
"severity": "Success",
"text": "The dependent was added.",
"code": null,
"additionalData": null
}
]
}
# Errors
The standard error responses apply.