Members
Changes
Legacy
- GETGet Member Request
- GETGet Employee Member Request List
- GETGet Organization Member Request List
- GETGet Member Transactions By Member Request
- POSTCreate a new Employee
- POSTCreate a new Dependent
- POSTCreate an Enrollment Snapshot Member Request
- POSTCreate a New Hire Enrollment Member Request
- POSTCreate a Open Enrollment Member Request
- POSTCreate a Qualifying Life Event Member Request
- POSTCreate a Demographic Change Member Request
- POSTCreate a Termination Member Request
- POSTCreate a COBRA Enrollment Member Request
- POSTCreate a COBRA Open Enrollment Member Request
- POSTCreate a COBRA Qualifying Life Event Member Request
- POSTCreate a COBRA Termination Member Request
- GET
curl --request POST \
--url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/member_requests/new_hire \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"coverages": [
{
"carrier_config": {},
"carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
"created": 1557512389,
"lines_of_coverage": {
"dental": {
"enrolling_members": [
{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
},
{
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
}
]
},
"vision": {
"enrolling_members": [
{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
},
{
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
}
]
}
},
"modified": 1564440756,
"signature_date": "2020-01-15"
}
]
}
'{
"body": {
"coverages": [
{
"carrier_config": {},
"carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
"lines_of_coverage": {
"dental": {
"enrolling_members": [
{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
},
{
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
}
]
},
"vision": {
"enrolling_members": [
{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
},
{
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
}
]
}
},
"signature_date": "2020-01-15"
}
]
},
"employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
"request_type": "new_hire",
"result": {},
"status": "processing",
"transactions": [
"a6e30204-87b2-4802-95a4-a156bd0f7435"
]
}Create a New Hire Enrollment Member Request
The new hire member request is used to add an existing employee, and optionally their dependents to multiple coverages at multiple carriers.
curl --request POST \
--url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/member_requests/new_hire \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"coverages": [
{
"carrier_config": {},
"carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
"created": 1557512389,
"lines_of_coverage": {
"dental": {
"enrolling_members": [
{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
},
{
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
}
]
},
"vision": {
"enrolling_members": [
{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
},
{
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
}
]
}
},
"modified": 1564440756,
"signature_date": "2020-01-15"
}
]
}
'{
"body": {
"coverages": [
{
"carrier_config": {},
"carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9",
"lines_of_coverage": {
"dental": {
"enrolling_members": [
{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
},
{
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "ff033377-59e2-40df-8206-8cec3a725411"
}
]
},
"vision": {
"enrolling_members": [
{
"id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"member_type": "employee",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
},
{
"id": "165d4537-be5f-4744-8a97-a5b10fcb75b1",
"member_type": "dependent",
"plan_id": "08f9e430-9686-4b07-9e2c-6b26b8133dc3"
}
]
}
},
"signature_date": "2020-01-15"
}
]
},
"employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea",
"id": "4f57e463-f4d5-4255-83d4-806b0cabaac5",
"request_type": "new_hire",
"result": {},
"status": "processing",
"transactions": [
"a6e30204-87b2-4802-95a4-a156bd0f7435"
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the employee related to the member request
"72af10df-a8b3-46f1-a114-ac36d4b8a6ea"
Body
List of coverages being added or waived with a set of carriers
1Show child attributes
Show child attributes
Carrier-specific data required for new hire enrollment
Unique identifier of the carrier in the Noyo system
Enrollment and waiving information for each line of coverage
Show child attributes
Show child attributes
Member transaction requests relating to accident coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to AD&D coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Elected volume for the type of coverage being selected
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to cancer coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to critical illness coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Elected volume for the type of coverage being selected
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to dental coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to health fund coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Elected volume for the type of coverage being selected
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to hospital indemnity coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to life coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Elected volume for the type of coverage being selected
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to LTD coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Elected volume for the type of coverage being selected
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to medical coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to pharmacy coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to STD coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Elected volume for the type of coverage being selected
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to vision coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
Member transaction requests relating to wellness coverage
Show child attributes
Show child attributes
Details for members enrolling in coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member adding coverage
dependent, employee Unique identifier of the group plan in Noyo
Details for members waiving coverage
Show child attributes
Show child attributes
Unique identifier of the employee or dependent in Noyo
Type of member waiving coverage
dependent, employee Reason the member is waiving coverage
other-employee-group, other-spouse-group, other-parent-group, other-ind-on-exchange, other-ind-off-exchange, other-cobra, other-medicare, medicaid, medi-cal, va-coverage, tricare-coverage, retiree-coverage, no-coverage, voluntary-withdrawal Unique identifier of the group plan in Noyo
ISO-8601 date string for signature date
Response
Successful Response - Returns the new Member Request
Data required to execute a member request, varies depending on the request type
The date the record was created
Unique identifier of the employee in Noyo
Unique identifier of the record in Noyo
The date the record was last updated
Transaction type for the member request
demographic, new_hire, termination, open_enrollment, qualifying_life_event, enrollment_snapshot, cobra_enrollment, cobra_termination, cobra_open_enrollment, cobra_qualifying_life_event Result from executing the member request, varies depending on the request type
Status of the member request
processing, completed, failed, canceled Current version of the record
Timestamp indicating when a member request was marked as completed
List of unique identifiers of all associated member transactions in Noyo
Was this page helpful?