API Reference

Add dependants to existing user

post
https://connect-sandbox.onehub.global/users//dependants

Add dependant to existing user at Benifex platform. This endpoint allows a dependant to be added for an existing user. The response contains information about the user's newly added dependant.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The identifier of user id in OneHub.

Body Params

The request body for adding new dependant

string
required
length ≤ 100

The first name of the dependant.

string
required
length ≤ 100

The last name of the dependant.

date
required

The birth date of the dependant.

string
enum
required

User's gender. Only allowable values are Male, Female, Undefined, Unknown.

Allowed:
string
enum
required

User's relationship to the dependant.

string
enum

Dependant's nationality.

string
enum

Dependant's country of residence.

boolean

Boolean identifier if a dependant is currently an active dependant.

boolean

Boolean identifier if a dependant is visible to the user.

boolean

Boolean identifier if a dependant is in full time employment.

boolean

Boolean identifier if a dependant is permanently disabled.

string

The social security number of the dependant.

string

The full name of the dependant.

string
enum

Used internationally to determine eligibiity to e.g. add family members to medical cover. Only allowable values are Single, Married, Widowed, and Unknown.

Allowed:
string
enum

The status of the dependant. Note that the related setting must be enabled for dependants documents in Benefits tenant configuration. If not enabled the value is going to be ignored and set always as `Approved'.

Allowed:
date

The marriage date of the dependant.

date

The education end date of the dependant.

string

The additional surname of the dependant.

string
required

The unique email of the dependant.

string

The name of the dependant's mother.

Headers
string

An id that uniquely identifies the request. If added, this will aid any request debugging and can be used for idempotency checks

Responses

Updated 10 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago