POST
/
api
/
v1
/
employees
/
{employee_id}
/
dependents
curl --request POST \
  --url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/dependents \
  --header 'Content-Type: application/json' \
  --data '{
  "person": {
    "contact": {
      "email_address": "jamie@testemail.com",
      "email_address_type": "home",
      "home_phone": "+12065551234"
    },
    "date_of_birth": "2000-01-02",
    "first_name": "Jamie",
    "home_address": {
      "city": "San Francisco",
      "county": "San Francisco",
      "state": "CA",
      "street_one": "1234 Home Ave",
      "zip_code": "94107"
    },
    "last_name": "Johnson",
    "marital_status": "single",
    "sex": "F",
    "ssn": "384032999"
  },
  "relationship": "child"
}'
{
  "created": 1626281253,
  "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
  "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
  "modified": 1626281253,
  "person": {
    "contact": {
      "email_address": "jamie@testemail.com",
      "email_address_type": "home",
      "home_phone": "+12065551234"
    },
    "date_of_birth": "2000-01-02",
    "first_name": "Jamie",
    "home_address": {
      "city": "San Francisco",
      "county": "San Francisco",
      "state": "CA",
      "street_one": "1234 Home Ave",
      "zip_code": "94107"
    },
    "last_name": "Johnson",
    "marital_status": "single",
    "sex": "F",
    "ssn": "384032999"
  },
  "relationship": "child",
  "version": "669fbe16-9960-4069-91aa-832ada3f4e42"
}

The Member Request workflow is now deprecated in favor of using Member Snapshot

Path Parameters

employee_id
string
required

The unique identifier of the employee the dependent belongs to

Body

application/json
person
object
required

Personal information for the dependent

relationship
enum<string>
required

Relationship of the dependent to the employee

Available options:
spouse,
child,
domestic-partner,
grandchild,
civil-union,
step-child,
foster-child,
adopted-child,
legal-guardianship,
ex-spouse,
other

Response

201 - application/json
Successful Response - Returns the new Dependent
created
integer
required

The date the record was originated

employee_id
string
required

Unique identifier of the employee in Noyo

id
string
required

Unique identifier of the dependent in Noyo

modified
integer
required

The date the record was last updated

person
object
required

Personal information for the dependent

relationship
enum<string>
required

Relationship of the dependent to the employee

Available options:
spouse,
child,
domestic-partner,
grandchild,
civil-union,
step-child,
foster-child,
adopted-child,
legal-guardianship,
ex-spouse,
other
version
string
required

Version of the dependent record

custom_individual_id
string

The custom identifier for this dependent in your system