{ "components": { "parameters": {}, "schemas": { "Address": { "properties": { "city": { "description": "City of the address", "example": "Bend", "type": "string" }, "county": { "description": "County of the address", "example": "Deschutes", "type": "string" }, "state": { "description": "State postal code of the address", "enum": [ "AK", "AL", "AR", "AS", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "FM", "GA", "GU", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MH", "MI", "MN", "MO", "MP", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OH", "OK", "OR", "PA", "PR", "PW", "RI", "SC", "SD", "TN", "TX", "UM", "UT", "VA", "VI", "VT", "WA", "WI", "WV", "WY" ], "example": "OR", "type": "string" }, "street_one": { "description": "Line one of the address", "example": "339 Hickory Street", "type": "string" }, "street_two": { "description": "Line two of the address", "example": "Apartment 5", "type": "string" }, "zip_code": { "description": "Zip code of the address", "example": "97701", "type": "string" } }, "required": [ "city", "state", "street_one", "zip_code" ], "type": "object" }, "ApiAddress": { "properties": { "city": { "description": "City of the new address", "example": "Toledo", "type": "string" }, "county": { "description": "County of the new address", "type": "string" }, "state": { "description": "State postal code of the new address", "enum": [ "AK", "AL", "AR", "AS", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "FM", "GA", "GU", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MH", "MI", "MN", "MO", "MP", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OH", "OK", "OR", "PA", "PR", "PW", "RI", "SC", "SD", "TN", "TX", "UM", "UT", "VA", "VI", "VT", "WA", "WI", "WV", "WY" ], "example": "OH", "type": "string" }, "street_one": { "description": "Line one of the new address", "example": "7303 Laurel Street", "type": "string" }, "street_two": { "description": "Line two of the new address", "example": "Apartment 2", "type": "string" }, "zip_code": { "description": "Zip code of the new address", "example": "43460", "type": "string" } }, "required": [ "city", "state", "street_one", "zip_code" ], "type": "object" }, "ApiAddressChange": { "properties": { "home_address": { "$ref": "#/components/schemas/ApiAddress", "description": "New home address of the person" }, "mailing_address": { "$ref": "#/components/schemas/ApiAddress", "description": "New mailing address of the person" } }, "type": "object" }, "ApiBaseMemberAddingCoveragePriorCoverageWithVolume": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "prior_coverage": { "description": "Details about prior insurance coverage, if applicable", "properties": { "carrier_name": { "description": "Name of insurance carrier providing prior coverage", "type": "string" }, "last_coverage_date": { "description": "ISO-8601 date string of the last day of coverage with the prior insurance carrier", "type": "string" } }, "required": [ "carrier_name", "last_coverage_date" ], "type": "object" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "ApiBaseMemberDemographicChangeDetails": { "properties": { "address_change": { "$ref": "#/components/schemas/ApiAddressChange", "description": "Details about a demographic address change request" }, "classifications_change": { "description": "Details about a demographic classifications change request", "type": "object" }, "contact_change": { "$ref": "#/components/schemas/ApiContactChange", "description": "Details about a demographic contact change request" }, "dob_change": { "description": "Details about a demographic date of birth change request", "properties": { "date_of_birth": { "description": "ISO-8601 date string for the new or corrected date of birth of the person", "example": "1982-05-13", "type": "string" } }, "required": [ "date_of_birth" ], "type": "object" }, "employment_change": { "$ref": "#/components/schemas/ApiEmploymentChange", "description": "Details about a demographic employment change request" }, "member": { "description": "Details about the member making a demographic change request", "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "type": { "description": "Type of member making a demographic request", "enum": [ "dependent", "employee" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "name_change": { "$ref": "#/components/schemas/ApiNameChange", "description": "Details about a demographic name change request" }, "salary_change": { "$ref": "#/components/schemas/ApiSalaryChange", "description": "Details about a demographic salary change request" }, "sex_change": { "description": "Details about a demographic sex change request", "properties": { "sex": { "description": "New sex of the person", "enum": [ "F", "M", "U", "X" ], "example": "F", "type": "string" } }, "required": [ "sex" ], "type": "object" }, "ssn_change": { "description": "Details about a demographic Social Security Number change request", "properties": { "ssn": { "description": "New or corrected Social Security Number of the person", "type": "string" } }, "required": [ "ssn" ], "type": "object" } }, "required": [ "member" ], "type": "object" }, "ApiBaseNewHireChangeCarrierCoverages": { "properties": { "carrier_config": { "description": "Carrier-specific data required for new hire enrollment", "type": "object" }, "carrier_id": { "description": "Unique identifier of the carrier in the Noyo system", "format": "uuid", "type": "string" }, "lines_of_coverage": { "$ref": "#/components/schemas/ApiBaseNewHireMemberLinesOfCoverage", "description": "Enrollment and waiving information for each line of coverage" }, "signature_date": { "description": "ISO-8601 date string for signature date", "type": "string" } }, "required": [ "carrier_config", "carrier_id", "lines_of_coverage" ], "type": "object" }, "ApiBaseNewHireMemberLinesOfCoverage": { "properties": { "accident": { "description": "Member transaction requests relating to accident coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "add": { "description": "Member transaction requests relating to AD&D coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "cancer": { "description": "Member transaction requests relating to cancer coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "critical_illness": { "description": "Member transaction requests relating to critical illness coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "dental": { "description": "Member transaction requests relating to dental coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "hospital_indemnity": { "description": "Member transaction requests relating to hospital indemnity coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "life": { "description": "Member transaction requests relating to life coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ltd": { "description": "Member transaction requests relating to LTD coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "medical": { "description": "Member transaction requests relating to medical coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "std": { "description": "Member transaction requests relating to STD coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "vision": { "description": "Member transaction requests relating to vision coverage", "properties": { "enrolling_members": { "description": "Details for members enrolling in coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "waiving_members": { "description": "Details for members waiving coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" }, "ApiBaseOpenEnrollmentEventDetails": { "properties": { "event_date": { "description": "ISO-8601 date string for open enrollment date", "type": "string" }, "event_type": { "description": "Open enrollment event type", "enum": [ "open_enrollment" ], "type": "string" } }, "type": "object" }, "ApiBaseQualifyingLifeEventDetails": { "properties": { "event_date": { "description": "ISO-8601 date string for qualifying life event date", "type": "string" }, "event_type": { "description": "Qualifying life event type", "enum": [ "adoption", "change_to_full_time", "change_to_part_time", "classifications_change", "court_order", "death", "dependent_open_enrollment", "divorce", "foster_care", "immigration_status_change", "legal_guardian", "lost_coverage", "marriage", "medicare", "moved", "newborn", "offline_change", "override", "rate_changed", "rehire", "reinstatement" ], "type": "string" } }, "required": [ "event_date", "event_type" ], "type": "object" }, "ApiCOBRAMembersChangeLinesOfCoverage": { "properties": { "dental": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to dental coverage" }, "medical": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to medical coverage" }, "vision": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to vision coverage" } }, "type": "object" }, "ApiCOBRAOpenEnrollmentCarrierCoverages": { "properties": { "carrier_config": { "description": "Carrier-specific data required for member request", "type": "object" }, "carrier_id": { "description": "Unique identifier of the carrier in the Noyo system", "format": "uuid", "type": "string" }, "coverage_start_date": { "description": "ISO-8601 date string for coverage start date", "type": "string" }, "lines_of_coverage": { "$ref": "#/components/schemas/ApiCOBRAMembersChangeLinesOfCoverage", "description": "Adding, removing and modifying information for each line of coverage" }, "signature_date": { "description": "ISO-8601 date string for signature date", "type": "string" } }, "required": [ "carrier_config", "carrier_id", "lines_of_coverage" ], "type": "object" }, "ApiCOBRAQualifyingLifeEventCarrierCoverages": { "properties": { "carrier_config": { "description": "Carrier-specific data required for member request", "type": "object" }, "carrier_id": { "description": "Unique identifier of the carrier in the Noyo system", "format": "uuid", "type": "string" }, "lines_of_coverage": { "$ref": "#/components/schemas/ApiCOBRAMembersChangeLinesOfCoverage", "description": "Adding, removing and modifying information for each line of coverage" }, "signature_date": { "description": "ISO-8601 date string for signature date", "type": "string" } }, "required": [ "carrier_config", "carrier_id", "lines_of_coverage" ], "type": "object" }, "ApiContactChange": { "properties": { "email_address": { "description": "New email address of the person", "example": "jane.doe@example.com", "format": "email", "type": "string" }, "email_address_type": { "description": "Type of new email address", "enum": [ "home", "work" ], "example": "home", "type": "string" }, "home_phone": { "description": "New home phone number in E.164 format", "example": "+15555551212", "type": "string" }, "work_phone": { "description": "New work phone number in E.164 format", "example": "+15555551212", "type": "string" } }, "type": "object" }, "ApiEmploymentChange": { "properties": { "employment_status": { "description": "New or updated employee employment status", "enum": [ "contract", "disabled", "full-time", "part-time", "retired", "terminated" ], "example": "full-time", "type": "string" }, "hire_date": { "description": "ISO-8601 date string for the new or corrected hire date of the employee", "example": "2017-05-23", "type": "string" }, "hours_worked": { "description": "New number of hours worked per week by the employee", "example": 40, "format": "int32", "minimum": 0, "type": "integer" }, "occupation": { "description": "New or updated employee occupation or job title", "example": "Engineer", "type": "string" } }, "type": "object" }, "ApiMembersChangeCoverageAction": { "properties": { "adding_coverage": { "description": "Details for members adding coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "prior_coverage": { "description": "Details about prior insurance coverage, if applicable", "properties": { "carrier_name": { "description": "Name of insurance carrier providing prior coverage", "type": "string" }, "last_coverage_date": { "description": "ISO-8601 date string of the last day of coverage with the prior insurance carrier", "type": "string" } }, "required": [ "carrier_name", "last_coverage_date" ], "type": "object" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "modifying_coverage": { "description": "Details for members modifying coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member modifying coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "removing_coverage": { "description": "Details for members removing coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member removing coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is removing or canceling coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ApiMembersChangeCoverageActionWithVolume": { "properties": { "adding_coverage": { "description": "Details for members adding coverage with volume", "items": { "$ref": "#/components/schemas/ApiBaseMemberAddingCoveragePriorCoverageWithVolume" }, "type": "array" }, "modifying_coverage": { "description": "Details for members modifying coverage with volume", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member modifying coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "type": "array" }, "removing_coverage": { "description": "Details for members removing coverage", "items": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member removing coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is removing or canceling coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ApiMembersChangeLinesOfCoverage": { "properties": { "accident": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to accident coverage" }, "add": { "$ref": "#/components/schemas/ApiMembersChangeCoverageActionWithVolume", "description": "Member transaction requests relating to AD&D coverage" }, "cancer": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to cancer coverage" }, "critical_illness": { "$ref": "#/components/schemas/ApiMembersChangeCoverageActionWithVolume", "description": "Member transaction requests relating to critical illness coverage" }, "dental": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to dental coverage" }, "hospital_indemnity": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to hospital indemnity coverage" }, "life": { "$ref": "#/components/schemas/ApiMembersChangeCoverageActionWithVolume", "description": "Member transaction requests relating to life coverage" }, "ltd": { "$ref": "#/components/schemas/ApiMembersChangeCoverageActionWithVolume", "description": "Member transaction requests relating to LTD coverage" }, "medical": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to medical coverage" }, "std": { "$ref": "#/components/schemas/ApiMembersChangeCoverageActionWithVolume", "description": "Member transaction requests relating to STD coverage" }, "vision": { "$ref": "#/components/schemas/ApiMembersChangeCoverageAction", "description": "Member transaction requests relating to vision coverage" } }, "type": "object" }, "ApiNameChange": { "properties": { "first_name": { "description": "New first name of the person", "example": "Jane", "type": "string" }, "last_name": { "description": "New last name of the person", "example": "Doe", "type": "string" }, "middle_name": { "description": "New middle name of the person", "example": "Ellen", "type": "string" }, "suffix": { "description": "New name suffix of the person", "example": "Jr", "type": "string" } }, "required": [ "first_name", "last_name" ], "type": "object" }, "ApiOpenEnrollmentCarrierCoverages": { "properties": { "carrier_config": { "description": "Carrier-specific data required for member request", "type": "object" }, "carrier_id": { "description": "Unique identifier of the carrier in the Noyo system", "format": "uuid", "type": "string" }, "coverage_start_date": { "description": "ISO-8601 date string for coverage start date", "type": "string" }, "lines_of_coverage": { "$ref": "#/components/schemas/ApiMembersChangeLinesOfCoverage", "description": "Adding, removing and modifying information for each line of coverage" }, "signature_date": { "description": "ISO-8601 date string for signature date", "type": "string" } }, "required": [ "carrier_config", "carrier_id", "lines_of_coverage" ], "type": "object" }, "ApiQualifyingLifeEventCarrierCoverages": { "properties": { "carrier_config": { "description": "Carrier-specific data required for member request", "type": "object" }, "carrier_id": { "description": "Unique identifier of the carrier in the Noyo system", "format": "uuid", "type": "string" }, "lines_of_coverage": { "$ref": "#/components/schemas/ApiMembersChangeLinesOfCoverage", "description": "Adding, removing and modifying information for each line of coverage" }, "signature_date": { "description": "ISO-8601 date string for signature date", "type": "string" } }, "required": [ "carrier_config", "carrier_id", "lines_of_coverage" ], "type": "object" }, "ApiSalaryChange": { "properties": { "amount": { "description": "New or updated amount of salary earned by the employee in US dollars", "example": 55000, "minimum": 0, "type": "number" }, "type": { "description": "New or updated type of salary earned by the employee", "enum": [ "hourly", "salary" ], "example": "salary", "type": "string" }, "unit": { "description": "New or updated unit of salary earned by the employee", "enum": [ "annual", "hour", "month", "semi-monthly", "week" ], "example": "annual", "type": "string" } }, "required": [ "amount", "type", "unit" ], "type": "object" }, "CarrierMappedFieldResult": { "properties": { "carrier_id": { "description": "Unique identifier of the carrier we are creating mapped field for", "format": "uuid", "readOnly": true, "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "label": { "description": "User friendly label for the mapped field name", "nullable": true, "readOnly": true, "type": "string" }, "mapped_field": { "description": "Field name that is being mapped to within the object", "readOnly": true, "type": "string" }, "mapping_type": { "description": "Describes the type of mapping this carrier mapped field falls under", "enum": [ "account_structure", "plan" ], "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "object_name": { "description": "Name of group carrier configuration object", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "carrier_id", "created", "id", "mapped_field", "modified", "object_name", "version" ], "type": "object" }, "ConditionCreateRequest": { "properties": { "details": { "description": "Details of the condition", "properties": { "left_operand": { "description": "Field name that is being evaluated", "type": "string" }, "operator": { "description": "Operation we are evaluating between the left and right operands", "enum": [ "begins_with", "between", "contains", "ends_with", "greater_than", "is", "is_at_least_one_of", "is_not", "is_not_one_of", "is_one_of", "less_than" ], "nullable": true, "type": "string" }, "right_operand": { "description": "The resulting value of the conditional", "nullable": true, "type": "string" } }, "type": "object" }, "rule_id": { "description": "Unique identifier of the rule we are creating a condition for", "format": "uuid", "type": "string" } }, "required": [ "details", "rule_id" ], "type": "object" }, "ConditionEditRequest": { "properties": { "details": { "description": "Details of the condition", "properties": { "left_operand": { "description": "Field name that is being evaluated", "type": "string" }, "operator": { "description": "Operation we are evaluating between the left and right operands", "enum": [ "begins_with", "between", "contains", "ends_with", "greater_than", "is", "is_at_least_one_of", "is_not", "is_not_one_of", "is_one_of", "less_than" ], "nullable": true, "type": "string" }, "right_operand": { "description": "The resulting value of the conditional", "nullable": true, "type": "string" } }, "type": "object" } }, "required": [ "details" ], "type": "object" }, "ConditionResult": { "properties": { "created": { "description": "The date the record was created", "type": "integer" }, "details": { "description": "Details of the condition", "properties": { "left_operand": { "description": "Field name that is being evaluated", "type": "string" }, "operator": { "description": "Operation we are evaluating between the left and right operands", "enum": [ "begins_with", "between", "contains", "ends_with", "greater_than", "is", "is_at_least_one_of", "is_not", "is_not_one_of", "is_one_of", "less_than" ], "nullable": true, "type": "string" }, "right_operand": { "description": "The resulting value of the conditional", "nullable": true, "type": "string" } }, "readOnly": true, "type": "object" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "rule_id": { "description": "Unique identifier of the rule we are creating condition for", "format": "uuid", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "created", "details", "id", "modified", "rule_id", "version" ], "type": "object" }, "ContactResult": { "properties": { "created": { "description": "The date the record was originated", "readOnly": true, "type": "integer" }, "email": { "description": "Work email address of the group contact", "example": "catherine.briggs@example.com", "readOnly": true, "type": "string" }, "first_name": { "description": "First name of the group contact", "example": "Catherine", "readOnly": true, "type": "string" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the group contact in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "last_name": { "description": "Last name of the group contact", "example": "Briggs", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "readOnly": true, "type": "integer" }, "phone_number": { "description": "Work phone number of the group contact in E.164 format", "example": "+15555551212", "readOnly": true, "type": "string" }, "primary_contact": { "description": "True if contact is the primary contact for the group", "readOnly": true, "type": "boolean" }, "title": { "description": "Job title of the group contact", "example": "Engineer", "readOnly": true, "type": "string" }, "types": { "description": "List of contact types for the group contact", "items": { "enum": [ "billing", "company", "executive", "online" ], "type": "string" }, "minItems": 1, "type": "array" }, "version": { "description": "Version of the group contact record", "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "created", "group_id", "id", "modified", "types", "version" ], "type": "object" }, "CreatePersonRequest": { "properties": { "contact": { "$ref": "#/components/schemas/PersonContact", "description": "Contact information for the person" }, "date_of_birth": { "description": "ISO-8601 date string for the date of birth of the person", "example": "1977-06-03", "format": "date", "type": "string" }, "details": { "$ref": "#/components/schemas/PersonDetails", "description": "Additional personal details of the person" }, "first_name": { "description": "First name of the person", "example": "Catherine", "type": "string" }, "home_address": { "$ref": "#/components/schemas/Address", "description": "Home address of the person" }, "last_name": { "description": "Last name of the person", "example": "Briggs", "type": "string" }, "maiden_name": { "description": "Maiden name of the person (deprecated)", "type": "string" }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address of the person, if different from home address" }, "marital_status": { "description": "Marital status of the person", "enum": [ "divorced", "domestic-partner", "legally-separated", "married", "single", "widowed" ], "example": "married", "type": "string" }, "middle_name": { "description": "Middle name of the person", "example": "S", "type": "string" }, "sex": { "description": "Sex of the person", "enum": [ "F", "M", "U", "X" ], "example": "F", "type": "string" }, "ssn": { "description": "Social Security Number of the person", "example": "123456789", "nullable": true, "type": "string" }, "suffix": { "description": "Suffix of the person", "type": "string" } }, "required": [ "date_of_birth", "first_name", "home_address", "last_name", "sex" ], "type": "object" }, "DependentCreateRequest": { "properties": { "person": { "$ref": "#/components/schemas/CreatePersonRequest", "description": "Personal information for the dependent" }, "relationship": { "description": "Relationship of the dependent to the employee", "enum": [ "adopted-child", "child", "civil-union", "domestic-partner", "ex-spouse", "foster-child", "grandchild", "legal-guardianship", "other", "spouse", "step-child" ], "type": "string" } }, "required": [ "person", "relationship" ], "type": "object" }, "DependentResult": { "properties": { "created": { "description": "The date the record was originated", "readOnly": true, "type": "integer" }, "custom_individual_id": { "description": "The custom identifier for this dependent in your system", "readOnly": true, "type": "string" }, "employee_id": { "description": "Unique identifier of the employee in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the dependent in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "readOnly": true, "type": "integer" }, "person": { "$ref": "#/components/schemas/Person", "description": "Personal information for the dependent" }, "relationship": { "description": "Relationship of the dependent to the employee", "enum": [ "adopted-child", "child", "civil-union", "domestic-partner", "ex-spouse", "foster-child", "grandchild", "legal-guardianship", "other", "spouse", "step-child" ], "type": "string" }, "version": { "description": "Version of the dependent record", "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "created", "employee_id", "id", "modified", "person", "relationship", "version" ], "type": "object" }, "DiscrepancyNoteCreateRequest": { "properties": { "content": { "description": "Content of the note", "type": "string" } }, "required": [ "content" ], "type": "object" }, "DiscrepancyNoteResult": { "properties": { "author_type": { "description": "A constant that describes whether the note is from noyo or the organization/distributor", "readOnly": true, "type": "string" }, "content": { "description": "Message regarding the discrepancy sent by noyo or the organization", "example": "Our records reflect that they should be enrolled at the carrier, can you update?", "readOnly": true, "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "discrepancy_id": { "description": "Unique identifier of the associated discrepancy", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "author_type", "content", "created", "discrepancy_id", "id", "modified", "version" ], "type": "object" }, "EmployeeCreateRequest": { "properties": { "classifications": { "description": "Fields that classify employees for group structure mapping", "type": "object" }, "employment": { "$ref": "#/components/schemas/Employment", "description": "Employment information for the employee" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "type": "string" }, "location_id": { "description": "Unique identifier of the employee group location in Noyo", "format": "uuid", "type": "string" }, "person": { "$ref": "#/components/schemas/CreatePersonRequest", "description": "Personal information for the employee" } }, "required": [ "employment", "group_id", "person" ], "type": "object" }, "EmployeeQueryRequest": { "properties": { "date_of_birth": { "description": "ISO-8601 date string for the date of birth of the employee to be filtered on", "example": "1977-06-03", "format": "date", "type": "string" }, "first_name": { "description": "First name of the employee to be filtered on", "example": "Catherine", "type": "string" }, "last_name": { "description": "Last name of the employee to be filtered on", "example": "Briggs", "type": "string" }, "name": { "description": "A name search for all name fields for the employee to be filtered on", "example": "Lauren S. Jones", "type": "string" } }, "type": "object" }, "EmployeeResult": { "properties": { "classifications": { "description": "Fields that classify employees for group structure mapping", "readOnly": true, "type": "object" }, "created": { "description": "The date the record was originated", "readOnly": true, "type": "integer" }, "custom_individual_id": { "description": "The custom identifier for this employee in your system", "readOnly": true, "type": "string" }, "employment": { "$ref": "#/components/schemas/EmploymentResult", "description": "Employment information for the employee" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the employee in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "location_id": { "description": "Unique identifier of the employee group location in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "readOnly": true, "type": "integer" }, "person": { "$ref": "#/components/schemas/Person", "description": "Personal information for the employee" }, "version": { "description": "Version of the employee record", "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "created", "employment", "group_id", "id", "modified", "person", "version" ], "type": "object" }, "EmployeeStatusResult": { "properties": { "carrier_statuses": { "description": "List of employee statuses with any relevant carriers", "items": { "properties": { "carrier_id": { "description": "Unique identifier of the carrier in Noyo", "format": "uuid", "type": "string" }, "latest_platform_change": { "description": "Details on the latest change sent to Noyo to be applied at the carrier", "properties": { "error": { "description": "The error message explaining any issues from the platform change", "properties": { "message": { "description": "The error message for the latest change", "type": "string" } }, "required": [ "message" ], "type": "object" }, "id": { "description": "Unique identifier of the platform change record", "format": "uuid", "type": "string" }, "status": { "description": "The status of the platform change", "type": "string" }, "type": { "description": "The type of the platform change record", "enum": [ "member_request", "member_snapshot" ], "type": "string" } }, "required": [ "id", "status", "type" ], "type": "object" }, "pending_changes": { "description": "A list of any open changes being processed with the carrier", "items": { "properties": { "id": { "description": "Unique identifier of the platform change record", "format": "uuid", "type": "string" }, "status": { "description": "The status of the platform change", "type": "string" }, "type": { "description": "The type of the platform change record", "enum": [ "member_request", "member_snapshot" ], "type": "string" } }, "required": [ "id", "status", "type" ], "type": "object" }, "type": "array" }, "status": { "description": "The member status related to the latest requested platform changes", "enum": [ "pending_changes", "stable", "unable_to_fulfill" ], "type": "string" } }, "required": [ "pending_changes", "status" ], "type": "object" }, "type": "array" } }, "required": [ "carrier_statuses" ], "type": "object" }, "Employment": { "properties": { "employment_dates": { "$ref": "#/components/schemas/EmploymentDates", "description": "Employee employment dates" }, "employment_status": { "description": "Employee employment status", "enum": [ "contract", "disabled", "full-time", "part-time", "retired", "terminated" ], "type": "string" }, "hours_worked": { "description": "An integer of hours worked per week by the employee", "example": 40, "format": "int32", "type": "integer" }, "occupation": { "description": "Employee occupation or job title", "example": "Engineer", "type": "string" }, "salary": { "$ref": "#/components/schemas/Salary", "description": "Employee salary information" } }, "required": [ "employment_dates", "employment_status", "hours_worked" ], "type": "object" }, "EmploymentDates": { "properties": { "full_time_start": { "description": "ISO-8601 date string for start date as a full time employee with the group (if applicable)", "example": "2017-01-17", "type": "string" }, "hire_date": { "description": "ISO-8601 date string for the hire date of the employee", "example": "2017-01-17", "format": "date", "type": "string" }, "rehire": { "description": "ISO-8601 date string for the rehire date of the employee (if applicable)", "example": "2018-02-01", "type": "string" }, "retirement": { "description": "ISO-8601 date string for the retirement date of the employee (if applicable)", "example": "2019-01-01", "type": "string" }, "terminated": { "description": "ISO-8601 date string for the termination date of the employee (if applicable)", "example": "2018-01-01", "type": "string" } }, "required": [ "hire_date" ], "type": "object" }, "EmploymentDatesResult": { "properties": { "full_time_start": { "description": "ISO-8601 date string for start date as a full time employee with the group (if applicable)", "example": "2017-01-17", "type": "string" }, "hire_date": { "description": "ISO-8601 date string for the hire date of the employee", "example": "2017-01-17", "format": "date", "type": "string" }, "rehire": { "description": "ISO-8601 date string for the rehire date of the employee (if applicable)", "example": "2018-02-01", "type": "string" }, "retirement": { "description": "ISO-8601 date string for the retirement date of the employee (if applicable)", "example": "2019-01-01", "type": "string" }, "terminated": { "description": "ISO-8601 date string for the termination date of the employee (if applicable)", "example": "2018-01-01", "type": "string" } }, "type": "object" }, "EmploymentResult": { "properties": { "employment_dates": { "$ref": "#/components/schemas/EmploymentDatesResult", "description": "Employee employment dates" }, "employment_status": { "description": "Employee employment status", "enum": [ "contract", "disabled", "full-time", "part-time", "retired", "terminated" ], "type": "string" }, "hours_worked": { "description": "An integer of hours worked per week by the employee", "example": 40, "format": "int32", "type": "integer" }, "occupation": { "description": "Employee occupation or job title", "example": "Engineer", "type": "string" }, "salary": { "$ref": "#/components/schemas/Salary", "description": "Employee salary information" } }, "required": [ "employment_dates", "employment_status", "hours_worked" ], "type": "object" }, "GroupADDPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "code": { "description": "Plan code of the group AD&D plan", "example": "ADD", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group AD&D plan", "items": { "description": "Member type eligible for the group AD&D plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group AD&D plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group AD&D plan", "example": "Employee Basic AD&D", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group AD&D plan", "enum": [ "basic", "voluntary" ], "type": "string" }, "status": { "description": "Status of the group AD&D plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group AD&D plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "volume_rules": { "description": "Volume rules for the group AD&D plan", "type": "object" }, "waiting_periods": { "description": "Member waiting period details for the group AD&D plan", "items": { "description": "Member waiting period details for the group AD&D plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "plan_type", "status", "termination_policy", "version", "volume_rules", "waiting_periods" ], "type": "object" }, "GroupAccidentPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "code": { "description": "Plan code of the group accident plan", "example": "VACC", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group accident plan", "items": { "description": "Member type eligible for the group accident plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group accident plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group accident plan", "example": "Voluntary Accident - Employee", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group accident plan", "enum": [ "basic", "voluntary" ], "type": "string" }, "status": { "description": "Status of the group accident plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group accident plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "waiting_periods": { "description": "Member waiting period details for the group accident plan", "items": { "description": "Member waiting period details for the group accident plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "plan_type", "status", "termination_policy", "version", "waiting_periods" ], "type": "object" }, "GroupCancerPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "code": { "description": "Plan code of the group cancer plan", "example": "CAN", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group cancer plan", "items": { "description": "Member type eligible for the group cancer plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group cancer plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group cancer plan", "example": "Cancer - Employee", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group cancer plan", "enum": [ "basic", "voluntary" ], "type": "string" }, "status": { "description": "Status of the group cancer plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group cancer plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "waiting_periods": { "description": "Member waiting period details for the group cancer plan", "items": { "description": "Member waiting period details for the group cancer plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "plan_type", "status", "termination_policy", "version", "waiting_periods" ], "type": "object" }, "GroupCoverageExportCreateRequest": { "properties": { "as_of": { "description": "ISO-8601 Date to query group coverage data", "format": "date", "type": "string" }, "carrier_ids": { "description": "List of carrier IDs to only include in requested group coverage export", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "type": "object" }, "GroupCoverageExportResult": { "properties": { "as_of": { "description": "ISO-8601 Date to query group coverage data", "format": "date", "readOnly": true, "type": "string" }, "carrier_ids": { "description": "List of carrier IDs to only include in requested group coverage export", "items": { "format": "uuid", "type": "string" }, "readOnly": true, "type": "array" }, "completed": { "description": "Timestamp indicating when the group coverage export was completed", "example": "1673452723", "readOnly": true, "type": "integer" }, "created": { "description": "The date the record was created", "type": "integer" }, "expires": { "description": "Timestamp indicating when the group coverage export expired", "example": "1673826563", "readOnly": true, "type": "integer" }, "file_format": { "description": "File format of the group coverage export", "example": "csv", "readOnly": true, "type": "string" }, "group_id": { "description": "Unique identifier of the associated group in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "percentage_complete": { "description": "Percentage of the group coverage export that has been completed", "example": 0.5, "format": "float", "readOnly": true, "type": "number" }, "request_user_id": { "description": "Unique identifier of the user who requested the group coverage export", "format": "uuid", "readOnly": true, "type": "string" }, "status": { "description": "Status of the group_coverage_export", "example": "processing", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "as_of", "carrier_ids", "completed", "created", "expires", "file_format", "group_id", "id", "modified", "percentage_complete", "request_user_id", "status", "version" ], "type": "object" }, "GroupCriticalIllnessPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "code": { "description": "Plan code of the group critical illness plan", "example": "VCI", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group critical illness plan", "items": { "description": "Member type eligible for the group critical illness plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group critical illness plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group critical illness plan", "example": "Critical Illness - Employee", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group critical illness plan", "enum": [ "basic", "voluntary" ], "type": "string" }, "status": { "description": "Status of the group critical illness plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group critical illness plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "volume_rules": { "description": "Volume rules for the group critical illness plan", "type": "object" }, "waiting_periods": { "description": "Member waiting period details for the group critical illness plan", "items": { "description": "Member waiting period details for the group critical illness plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "plan_type", "status", "termination_policy", "version", "volume_rules", "waiting_periods" ], "type": "object" }, "GroupDentalPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "cobra_rules": { "description": "COBRA rules for the group dental plan", "properties": { "eligible": { "description": "True if group plan is eligible for COBRA enrollments", "type": "boolean" } }, "type": "object" }, "code": { "description": "Plan code of the group dental plan", "example": "SP100", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group dental plan", "items": { "description": "Member type eligible for the group dental plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group dental plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group dental plan", "example": "Smile Plus 1000", "type": "string" }, "network": { "description": "Network name of the plan designated by the carrier", "example": "Dental Select", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group dental plan", "enum": [ "aso", "dhmo", "epo", "indemnity", "pos", "ppo" ], "type": "string" }, "status": { "description": "Status of the group dental plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group dental plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "voluntary": { "description": "True if the group dental plan is a voluntary plan", "type": "boolean" }, "waiting_periods": { "description": "Member waiting period details for the group dental plan", "items": { "description": "Member waiting period details for the group dental plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "cobra_rules", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "status", "termination_policy", "version", "waiting_periods" ], "type": "object" }, "GroupDisconnectionBulkRequestPublicCreateRequest": { "properties": { "carrier_ids": { "description": "Unique identifier of the carriers to be disconnected from.", "items": { "description": "Carrier ID to use for disconnecting request", "format": "uuid", "type": "string" }, "type": "array" }, "effective_end_date": { "description": "Unique identifier for the group to be disconnected.", "format": "date", "type": "string" }, "group_id": { "description": "Unique identifier for the group to be disconnected.", "format": "uuid", "type": "string" } }, "required": [ "carrier_ids", "effective_end_date", "group_id" ], "type": "object" }, "GroupDisconnectionBulkRequestResult": { "properties": { "response": { "description": "List of group disconnecting request results", "items": { "properties": { "carrier_id": { "description": "Unique identifier for the carrier to be disconnected from", "format": "uuid", "readOnly": true, "type": "string" }, "completed": { "description": "Timestamp at which the disconnection was completed", "readOnly": true, "type": "integer" }, "created": { "description": "The date the record was created", "type": "integer" }, "decided": { "description": "Timestamp at which the platform recorded a decision on the disconnection", "readOnly": true, "type": "integer" }, "effective_end_date": { "description": "The date at which the disconnection will take effect", "format": "date", "readOnly": true, "type": "string" }, "group_id": { "description": "Unique identifier for the group to be disconnected. May be missing if group has already been disconnected.", "format": "uuid", "readOnly": true, "type": "string" }, "group_name": { "description": "Name of the group to be disconnected from", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "organization_id": { "description": "Unique identifier for organization associated with the request", "format": "uuid", "readOnly": true, "type": "string" }, "source_id": { "description": "If applicable, the ID associated with the source of the disconnection request", "format": "uuid", "readOnly": true, "type": "string" }, "source_type": { "description": "The source of the disconnection request", "readOnly": true, "type": "string" }, "status": { "description": "The status of the disconnection request", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "carrier_id", "created", "group_name", "id", "modified", "organization_id", "source_id", "source_type", "status", "version" ], "type": "object" }, "type": "array" } }, "required": [ "response" ], "type": "object" }, "GroupDisconnectionRequestPublicConfirmRequest": { "properties": { "effective_end_date": { "description": "The date at which the disconnection will take effect - required if not already set", "format": "date", "type": "string" } }, "type": "object" }, "GroupDisconnectionRequestPublicCreateRequest": { "properties": { "carrier_id": { "description": "Unique identifier for the carrier to be disconnected from.", "format": "uuid", "type": "string" }, "effective_end_date": { "description": "Unique identifier for the group to be disconnected.", "format": "date", "type": "string" }, "group_id": { "description": "Unique identifier for the group to be disconnected.", "format": "uuid", "type": "string" } }, "required": [ "carrier_id", "effective_end_date", "group_id" ], "type": "object" }, "GroupDisconnectionRequestPublicEditRequest": { "properties": { "effective_end_date": { "description": "The date at which the disconnection will take effect - required if not already set", "format": "date", "type": "string" }, "status": { "description": "The status of the disconnection request", "enum": [ "processing", "rejected" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "GroupDisconnectionRequestPublicRejectRequest": { "properties": {}, "type": "object" }, "GroupDisconnectionRequestQueryRequest": { "properties": { "search": { "description": "Search group name, group id, or group disconnection request id", "type": "string" }, "status": { "description": "Status to filter by", "enum": [ "completed", "needs_review", "processing", "rejected" ], "type": "string" } }, "type": "object" }, "GroupDisconnectionRequestResult": { "properties": { "carrier_id": { "description": "Unique identifier for the carrier to be disconnected from", "format": "uuid", "readOnly": true, "type": "string" }, "completed": { "description": "Timestamp at which the disconnection was completed", "readOnly": true, "type": "integer" }, "created": { "description": "The date the record was created", "type": "integer" }, "decided": { "description": "Timestamp at which the platform recorded a decision on the disconnection", "readOnly": true, "type": "integer" }, "effective_end_date": { "description": "The date at which the disconnection will take effect", "format": "date", "readOnly": true, "type": "string" }, "group_id": { "description": "Unique identifier for the group to be disconnected. May be missing if group has already been disconnected.", "format": "uuid", "readOnly": true, "type": "string" }, "group_name": { "description": "Name of the group to be disconnected from", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "organization_id": { "description": "Unique identifier for organization associated with the request", "format": "uuid", "readOnly": true, "type": "string" }, "source_id": { "description": "If applicable, the ID associated with the source of the disconnection request", "format": "uuid", "readOnly": true, "type": "string" }, "source_type": { "description": "The source of the disconnection request", "readOnly": true, "type": "string" }, "status": { "description": "The status of the disconnection request", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "carrier_id", "created", "group_name", "id", "modified", "organization_id", "source_id", "source_type", "status", "version" ], "type": "object" }, "GroupEditRequest": { "properties": { "dba_name": { "description": "DBA name for the company, if applicable", "example": "Floors R Us", "type": "string" }, "federal_ein": { "description": "Federal Employer Identification Number for the company", "example": "112222222", "type": "string" }, "name": { "description": "Name of the group", "example": "ACME Flooring", "type": "string" }, "sic_code": { "description": "SIC Code of the group", "example": "5713", "type": "string" } }, "type": "object" }, "GroupEnrollmentPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in the Noyo system", "format": "uuid", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "group_id": { "description": "Unique identifier of the associated group in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group enrollment", "enum": [ "accident", "add", "cancer", "critical_illness", "dental", "hospital_indemnity", "life", "ltd", "medical", "std", "vision" ], "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "open_enrollment_end_date": { "description": "ISO-8601 date string for the open enrollment end date of the group enrollment", "example": "2018-11-30", "format": "date", "nullable": true, "type": "string" }, "open_enrollment_renewal_date": { "description": "ISO-8601 date string for the open enrollment renewal start date of the group enrollment", "example": "2018-12-01", "format": "date", "nullable": true, "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the open enrollment start date of the group enrollment", "example": "2018-11-01", "format": "date", "nullable": true, "type": "string" }, "status": { "description": "Status of the group enrollment", "enum": [ "active", "completed", "pending" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "carrier_id", "created", "group_id", "id", "line_of_coverage", "modified", "status", "version" ], "type": "object" }, "GroupHospitalIndemnityPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "code": { "description": "Plan code of the group hospital indemnity plan", "example": "VHI", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group hospital indemnity plan", "items": { "description": "Member type eligible for the group hospital indemnity plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group hospital indemnity plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group hospital indemnity plan", "example": "Hospital Indemnity - Employee", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group hospital indemnity plan", "enum": [ "basic", "voluntary" ], "type": "string" }, "status": { "description": "Status of the group hospital indemnity plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group hospital indemnity plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "waiting_periods": { "description": "Member waiting period details for the group hospital indemnity plan", "items": { "description": "Member waiting period details for the group hospital indemnity plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "plan_type", "status", "termination_policy", "version", "waiting_periods" ], "type": "object" }, "GroupLTDPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "code": { "description": "Plan code of the group LTD plan", "example": "LTD", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group LTD plan", "items": { "description": "Member type eligible for the group LTD plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group LTD plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group LTD plan", "example": "Employee LTD", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group LTD plan", "enum": [ "basic", "voluntary" ], "type": "string" }, "status": { "description": "Status of the group LTD plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group LTD plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "volume_rules": { "description": "Volume rules for the group LTD plan", "type": "object" }, "waiting_periods": { "description": "Member waiting period details for the group LTD plan", "items": { "description": "Member waiting period details for the group LTD plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "plan_type", "status", "termination_policy", "version", "volume_rules", "waiting_periods" ], "type": "object" }, "GroupLifePlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "code": { "description": "Plan code of the group life plan", "example": "LIFE", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group life plan", "items": { "description": "Member type eligible for the group life plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group life plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group life plan", "example": "Employee Basic Life", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group life plan", "enum": [ "basic", "voluntary" ], "type": "string" }, "status": { "description": "Status of the group life plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group life plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "volume_rules": { "description": "Volume rules for the group life plan", "type": "object" }, "waiting_periods": { "description": "Member waiting period details for the group life plan", "items": { "description": "Member waiting period details for the group life plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "plan_type", "status", "termination_policy", "version", "volume_rules", "waiting_periods" ], "type": "object" }, "GroupMedicalPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "cobra_rules": { "description": "COBRA rules for the group medical plan", "properties": { "eligible": { "description": "True if group plan is eligible for COBRA enrollments", "type": "boolean" } }, "type": "object" }, "code": { "description": "Plan code of the group medical plan", "example": "MP25", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "Eligible member types for the group medical plan", "example": [ "all" ], "items": { "type": "string" }, "readOnly": true, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group medical plan", "readOnly": true, "type": "string" }, "metal_tier": { "description": "Metal tier designation of the group medical plan", "enum": [ "bronze", "gold", "platinum", "silver" ], "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group medical plan", "example": "Gold PPO 2500", "type": "string" }, "network": { "description": "Network name of the plan designated by the carrier", "example": "Medical Select", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group medical plan", "enum": [ "epo", "hdhp", "hmo", "hmp", "pos", "ppo" ], "type": "string" }, "status": { "description": "Status of the group medical plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group medical plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "waiting_periods": { "description": "Member waiting period details for the group medical plan", "items": { "description": "Member waiting period details for the group medical plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "cobra_rules", "created", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "status", "termination_policy", "version", "waiting_periods" ], "type": "object" }, "GroupPlanPublicFixedCoincidingWaitingPeriod": { "properties": { "waiting_period_coinciding": { "description": "True if the effective date can equal the final day of waiting period", "type": "boolean" }, "waiting_period_enrollment_type": { "description": "Enrollment type to decide which relevant waiting period should be applied", "enum": [ "current_member", "new_member", "rehire" ], "type": "string" }, "waiting_period_rule": { "description": "Waiting period rule describing the waiting period for the member", "enum": [ "fifteenth_of_month_after_event", "fifteenth_of_month_after_hire_date", "first_of_month_after_event", "first_of_month_after_hire_date", "first_or_fifteenth_of_month_after_event", "first_or_fifteenth_of_month_after_hire_date" ], "type": "string" } }, "required": [ "waiting_period_coinciding", "waiting_period_enrollment_type", "waiting_period_rule" ], "type": "object" }, "GroupPlanPublicFixedWaitingPeriod": { "properties": { "waiting_period_enrollment_type": { "description": "Enrollment type to decide which relevant waiting period should be applied", "enum": [ "current_member", "new_member", "rehire" ], "type": "string" }, "waiting_period_rule": { "description": "Waiting period rule describing the waiting period for the member", "enum": [ "hire_date" ], "type": "string" } }, "required": [ "waiting_period_enrollment_type", "waiting_period_rule" ], "type": "object" }, "GroupPlanPublicVariableCoincidingWaitingPeriod": { "properties": { "waiting_period_amount": { "description": "Amount of time required for the waiting period", "format": "int32", "minimum": 0, "type": "integer" }, "waiting_period_coinciding": { "description": "True if the effective date can equal the final day of waiting period", "type": "boolean" }, "waiting_period_enrollment_type": { "description": "Enrollment type to decide which relevant waiting period should be applied", "enum": [ "current_member", "new_member", "rehire" ], "type": "string" }, "waiting_period_rule": { "description": "Waiting period rule describing the waiting period for the member", "enum": [ "fifteenth_of_month_after_waiting_period", "first_of_month_after_waiting_period", "first_or_fifteenth_of_month_after_waiting_period" ], "type": "string" }, "waiting_period_unit": { "description": "Unit of time required for the waiting period", "enum": [ "business_day", "day", "month", "week", "year" ], "type": "string" } }, "required": [ "waiting_period_amount", "waiting_period_coinciding", "waiting_period_enrollment_type", "waiting_period_rule", "waiting_period_unit" ], "type": "object" }, "GroupPlanPublicVariableWaitingPeriod": { "properties": { "waiting_period_amount": { "description": "Amount of time required for the waiting period", "format": "int32", "minimum": 0, "type": "integer" }, "waiting_period_enrollment_type": { "description": "Enrollment type to decide which relevant waiting period should be applied", "enum": [ "current_member", "new_member", "rehire" ], "type": "string" }, "waiting_period_rule": { "description": "Waiting period rule describing the waiting period for the member", "enum": [ "after_waiting_period" ], "type": "string" }, "waiting_period_unit": { "description": "Unit of time required for the waiting period", "enum": [ "business_day", "day", "month", "week", "year" ], "type": "string" } }, "required": [ "waiting_period_amount", "waiting_period_enrollment_type", "waiting_period_rule", "waiting_period_unit" ], "type": "object" }, "GroupPlanQueryRequest": { "properties": { "carrier_id": { "description": "Unique ID of the carrier on which to filter group plans", "format": "uuid", "type": "string" }, "effective_date": { "description": "Effective date for target record to query, defaults to today", "example": "2019-04-04", "format": "date", "type": "string" }, "line_of_coverage": { "description": "The line of coverage on which to filter group plans", "enum": [ "accident", "add", "cancer", "critical_illness", "dental", "hospital_indemnity", "life", "ltd", "medical", "std", "vision" ], "type": "string" }, "status": { "description": "The status on which to filter group plans", "enum": [ "active", "discontinued", "pending" ], "type": "string" } }, "type": "object" }, "GroupQueryRequest": { "properties": { "carrier_group_id": { "description": "Used for filtering for a carrier-specific group ID. Must be used with carrier_id", "type": "string" }, "carrier_id": { "description": "Used for filtering for a carrier-specific group ID. Filter by the Noyo carrier ID. Must be used with carrier_group_id", "format": "uuid", "type": "string" }, "company": { "description": "Name or DBA name of the company to filter on", "example": "Acme Inc", "type": "string" }, "group_ids": { "description": "Comma separated list of group IDs to filter on", "type": "string" } }, "type": "object" }, "GroupResult": { "properties": { "created": { "description": "The date the record was created", "type": "integer" }, "dba_name": { "description": "DBA name for the company, if applicable", "example": "Floors R Us", "type": "string" }, "federal_ein": { "description": "Federal Employer Identification Number for the company", "example": "112222222", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group", "example": "ACME Flooring", "type": "string" }, "organization_id": { "description": "Unique identifier of the platform or broker organization in Noyo", "format": "uuid", "type": "string" }, "sic_code": { "description": "SIC Code of the group", "example": "5713", "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "created", "id", "modified", "name", "organization_id", "version" ], "type": "object" }, "GroupSTDPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "code": { "description": "Plan code of the group STD plan", "example": "STD", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group STD plan", "items": { "description": "Member type eligible for the group STD plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group STD plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group STD plan", "example": "Employee STD", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "plan_type": { "description": "Type of group STD plan", "enum": [ "basic", "voluntary" ], "type": "string" }, "status": { "description": "Status of the group STD plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group STD plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "volume_rules": { "description": "Volume rules for the group STD plan", "type": "object" }, "waiting_periods": { "description": "Member waiting period details for the group STD plan", "items": { "description": "Member waiting period details for the group STD plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "plan_type", "status", "termination_policy", "version", "volume_rules", "waiting_periods" ], "type": "object" }, "GroupSetupRequestPublicAPICreateRequest": { "properties": { "carrier_id": { "description": "Unique identifier of the carrier in Noyo", "format": "uuid", "type": "string" }, "federal_ein": { "description": "Federal Employer Identification Number for the new group/company", "example": "123123123", "type": "string" }, "group_data": { "$ref": "#/components/schemas/GroupSetupRequestPublicGroupData", "description": "Carrier-specific data to execute a group connection" } }, "required": [ "carrier_id", "group_data" ], "type": "object" }, "GroupSetupRequestPublicAPINestedCreateRequest": { "properties": { "carrier_id": { "description": "Unique identifier of the carrier in Noyo", "format": "uuid", "type": "string" }, "group_data": { "$ref": "#/components/schemas/GroupSetupRequestPublicNestedGroupData", "description": "Carrier-specific data to execute a group connection" } }, "required": [ "carrier_id", "group_data" ], "type": "object" }, "GroupSetupRequestPublicAPIRetryRequest": { "properties": { "carrier_group_id": { "description": "Unique identifier for the group in the carrier system", "minLength": 1, "type": "string" } }, "type": "object" }, "GroupSetupRequestPublicGroupData": { "properties": { "broker_federal_ein": { "description": "Federal Employer Identification Number for the group's broker. Only needed where relevant for carrier authorization", "example": "123123123", "type": "string" }, "carrier_group_id": { "description": "Unique identifier for the group in the carrier system", "minLength": 1, "type": "string" }, "group_name": { "description": "Name for the group in the Noyo system", "minLength": 1, "type": "string" } }, "required": [ "carrier_group_id", "group_name" ], "type": "object" }, "GroupSetupRequestPublicNestedGroupData": { "properties": { "broker_federal_ein": { "description": "Federal Employer Identification Number for the group's broker. Only needed where relevant for carrier authorization", "example": "123123123", "type": "string" }, "carrier_group_id": { "description": "Unique identifier for the group in the carrier system", "minLength": 1, "type": "string" } }, "required": [ "carrier_group_id" ], "type": "object" }, "GroupSetupRequestPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "completed": { "description": "Timestamp indicating when a group connection was marked as completed.", "readOnly": true, "type": "integer" }, "created": { "description": "The date the record was created", "type": "integer" }, "group_data": { "description": "Carrier-specific data to execute a group connection", "properties": { "carrier_group_id": { "description": "Unique identifier for the group in the carrier system", "readOnly": true, "type": "string" }, "group_name": { "description": "Name for the group in the Noyo system", "readOnly": true, "type": "string" } }, "required": [ "carrier_group_id", "group_name" ], "type": "object" }, "group_id": { "description": "ID of associated group model", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the group connection in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "organization_id": { "description": "Unique identifier of the platform or broker organization in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "request_type": { "description": "Type of the group connection", "readOnly": true, "type": "string" }, "setup_result": { "description": "More information about the result of the group connection", "readOnly": true, "type": "object" }, "status": { "description": "Status of the group connection", "enum": [ "action_required", "carrier_authorization", "completed", "created", "noyo_review", "processing", "unable_to_connect", "waiting_on_carrier" ], "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "carrier_id", "created", "group_data", "id", "modified", "organization_id", "request_type", "setup_result", "status", "version" ], "type": "object" }, "GroupSetupRequestQueryRequest": { "properties": { "carrier_id": { "description": "Unique identifier of the carrier in Noyo", "format": "uuid", "type": "string" }, "organization_id": { "description": "Unique identifier of the organization in Noyo", "format": "uuid", "type": "string" }, "search": { "description": "Searches fields such as group connection ID, federal EIN, carrier specific ID, and group name", "example": "1234567-89", "type": "string" }, "status": { "description": "Status of the group connection request", "enum": [ "action_required", "carrier_authorization", "completed", "created", "noyo_review", "processing", "unable_to_connect", "waiting_on_carrier" ], "type": "string" } }, "type": "object" }, "GroupSetupRequestResult": { "properties": { "carrier_id": { "description": "Unique identifier of the carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "group_audit_request_id": { "description": "ID of associated group audit request model", "format": "uuid", "readOnly": true, "type": "string" }, "group_data": { "description": "Carrier-specific data required to execute a group connection", "readOnly": true, "type": "object" }, "group_id": { "description": "ID of associated group model", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the group connection in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "organization_id": { "description": "Unique identifier of the platform or broker organization in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "request_type": { "description": "Type of the group connection", "readOnly": true, "type": "string" }, "setup_result": { "description": "More information about the result of the group connection", "readOnly": true, "type": "object" }, "status": { "description": "Status of the group connection", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "carrier_id", "created", "group_data", "id", "modified", "organization_id", "request_type", "setup_result", "status", "version" ], "type": "object" }, "GroupVisionPlanPublicResult": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "cobra_rules": { "description": "COBRA rules for the group vision plan", "properties": { "eligible": { "description": "True if group plan is eligible for COBRA enrollments", "type": "boolean" } }, "type": "object" }, "code": { "description": "Plan code of the group vision plan", "example": "VP2000", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the record", "example": "2018-12-31", "format": "date", "nullable": true, "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the record", "example": "2018-01-01", "format": "date", "nullable": true, "type": "string" }, "eligible_member_types": { "description": "List of member types eligible for the group vision plan", "items": { "description": "Member type eligible for the group vision plan", "enum": [ "all", "child", "domestic-partner", "employee", "spouse" ], "type": "string" }, "minItems": 1, "type": "array" }, "group_enrollment_id": { "description": "Unique identifier of the associated group enrollment in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the group vision plan", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "name": { "description": "Name of the group vision plan", "example": "Vision Plus 2000", "type": "string" }, "plan_configuration": { "description": "Group plan configuration details", "readOnly": true, "type": "object" }, "status": { "description": "Status of the group vision plan", "enum": [ "active", "discontinued", "pending" ], "type": "string" }, "termination_policy": { "description": "Termination policy for the group vision plan", "enum": [ "end_of_month", "fifteenth_of_month", "last_work_date" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "voluntary": { "description": "True if the group vision plan is a voluntary plan", "type": "boolean" }, "waiting_periods": { "description": "Member waiting period details for the group vision plan", "items": { "description": "Member waiting period details for the group vision plan", "type": "object" }, "type": "array" } }, "required": [ "carrier_id", "cobra_rules", "created", "eligible_member_types", "group_enrollment_id", "id", "line_of_coverage", "modified", "name", "plan_configuration", "status", "termination_policy", "version", "waiting_periods" ], "type": "object" }, "IndividualEnrollmentResult": { "properties": { "cobra_enrollment": { "description": "Details about the member COBRA enrollment status, if applicable", "properties": { "cobra_enrolled": { "description": "True if member is enrolled in COBRA coverage", "type": "boolean" }, "cobra_type": { "description": "Type of COBRA enrollment for the member", "enum": [ "federal", "state" ], "type": "string" } }, "readOnly": true, "type": "object" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective date of the coverage", "example": "2017-01-17", "format": "date", "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective date of the coverage", "example": "2017-01-17", "format": "date", "type": "string" }, "enroll_data": { "description": "Line of coverage specific enroll data with volume information", "readOnly": true, "type": "object" }, "group_enrollment_id": { "description": "Unique identifier of the group enrollment in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "individual_id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "individual_type": { "description": "Type of member for the individual enrollment", "enum": [ "dependent", "employee" ], "example": "employee", "readOnly": true, "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the individual enrollment", "enum": [ "accident", "add", "cancer", "critical_illness", "dental", "hospital_indemnity", "life", "ltd", "medical", "std", "vision" ], "example": "dental", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "status": { "description": "Status of the individual enrollment", "enum": [ "active", "pending", "terminated", "waived" ], "example": "active", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "cobra_enrollment", "created", "enroll_data", "group_enrollment_id", "id", "individual_id", "individual_type", "line_of_coverage", "modified", "plan_id", "status", "version" ], "type": "object" }, "LatestGroupAuditRequestRequest": { "properties": { "carrier_id": { "description": "Carrier ID used for group audit", "format": "uuid", "type": "string" } }, "type": "object" }, "LatestGroupAuditRequestResult": { "properties": { "carrier_ids": { "description": "List of carrier IDs included in group audit", "items": { "description": "Carrier ID used for group audit", "format": "uuid", "type": "string" }, "minItems": 1, "type": "array" }, "completed_at": { "description": "The date the group audit request was completed", "type": "integer" }, "group_id": { "description": "Unique identifier of the associated group in Noyo", "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "carrier_ids", "completed_at", "group_id" ], "type": "object" }, "LocationResult": { "properties": { "address": { "$ref": "#/components/schemas/Address", "description": "Address of the group location" }, "created": { "description": "The date the record was created", "type": "integer" }, "display_name": { "description": "Display name for the group location", "example": "Primary Company Location", "type": "string" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "address", "created", "display_name", "group_id", "id", "modified", "version" ], "type": "object" }, "MappingOperandResult": { "properties": { "created": { "description": "The date the record was created", "type": "integer" }, "existing_value_set": { "description": "List of values this operand can be one of", "items": { "type": "string" }, "readOnly": true, "type": "array" }, "field_type": { "description": "Field type for the operand", "readOnly": true, "type": "string" }, "group_id": { "description": "Unique identifier of the group at Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "mapping_type": { "description": "Describes the type of mapping", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "operand_path": { "description": "Path of the mapping operand from employee object", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "created", "existing_value_set", "field_type", "group_id", "id", "mapping_type", "modified", "operand_path", "version" ], "type": "object" }, "MemberAddingCoverage": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "MemberAddingCoveragePriorCoverage": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "prior_coverage": { "description": "Details about prior insurance coverage, if applicable", "properties": { "carrier_name": { "description": "Name of insurance carrier providing prior coverage", "type": "string" }, "last_coverage_date": { "description": "ISO-8601 date string of the last day of coverage with the prior insurance carrier", "type": "string" } }, "required": [ "carrier_name", "last_coverage_date" ], "type": "object" } }, "required": [ "id", "member_type" ], "type": "object" }, "MemberAddingCoveragePriorCoverageWithVolume": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "prior_coverage": { "description": "Details about prior insurance coverage, if applicable", "properties": { "carrier_name": { "description": "Name of insurance carrier providing prior coverage", "type": "string" }, "last_coverage_date": { "description": "ISO-8601 date string of the last day of coverage with the prior insurance carrier", "type": "string" } }, "required": [ "carrier_name", "last_coverage_date" ], "type": "object" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "MemberAddingCoverageWithVolume": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member adding coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "MemberCOBRAQualifyingLifeEventDetails": { "properties": { "event_date": { "description": "ISO-8601 date string for qualifying life event date", "type": "string" }, "event_type": { "description": "Qualifying life event type", "enum": [ "adoption", "change_to_full_time", "change_to_part_time", "classifications_change", "court_order", "death", "dependent_open_enrollment", "divorce", "foster_care", "immigration_status_change", "legal_guardian", "lost_coverage", "marriage", "medicare", "moved", "newborn", "offline_change", "rate_changed", "rehire", "reinstatement", "terminate_cobra" ], "type": "string" } }, "required": [ "event_date", "event_type" ], "type": "object" }, "MemberEnrollmentActionResult": { "properties": { "individual_enrollment_id": { "description": "Unique identifier of the individual enrollment in Noyo created by the member request", "format": "uuid", "type": "string" }, "member_id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member for the member enrollment result", "enum": [ "dependent", "employee" ], "type": "string" } }, "required": [ "individual_enrollment_id", "member_id", "member_type" ], "type": "object" }, "MemberModifyingCoverage": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member modifying coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "id", "member_type" ], "type": "object" }, "MemberModifyingCoverageWithVolume": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member modifying coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "volume": { "description": "Elected volume for the type of coverage being selected", "format": "int32", "type": "integer" } }, "required": [ "id", "member_type" ], "type": "object" }, "MemberOpenEnrollmentEventDetails": { "properties": { "event_date": { "description": "ISO-8601 date string for open enrollment date", "type": "string" }, "event_type": { "description": "Open enrollment event type", "enum": [ "open_enrollment" ], "type": "string" } }, "type": "object" }, "MemberPremiumBilledMember": { "properties": { "line_of_coverage": { "description": "Line of coverage for the billed group plan", "enum": [ "accident", "add", "cancer", "critical_illness", "dental", "hospital_indemnity", "life", "ltd", "medical", "std", "vision" ], "type": "string" }, "member_id": { "description": "Unique ID of the billed member in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member for the billed premium", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the billed group plan in Noyo", "format": "uuid", "type": "string" } }, "required": [ "line_of_coverage", "member_id", "member_type", "plan_id" ], "type": "object" }, "MemberPremiumQueryRequest": { "properties": { "effective_date": { "description": "Effective date for target record to query, defaults to today", "example": "2019-04-04", "format": "date", "type": "string" } }, "type": "object" }, "MemberPremiumResult": { "properties": { "amount": { "description": "Total amount of the premium in USD", "type": "number" }, "billed_members": { "description": "List of member enrollments that constitute the premium amount", "items": { "$ref": "#/components/schemas/MemberPremiumBilledMember" }, "type": "array" }, "carrier_id": { "description": "Unique ID of the carrier in Noyo", "format": "uuid", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective end date of the premium", "example": "2020-12-31", "format": "date", "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective start date of the premium", "example": "2020-01-01", "format": "date", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "period": { "description": "Time period for the premium", "properties": { "amount": { "description": "Length of premium period", "format": "int32", "minimum": 1, "type": "integer" }, "unit": { "description": "Unit frequency of premium period", "enum": [ "annual", "day", "month", "semi-monthly", "week" ], "type": "string" } }, "required": [ "amount", "unit" ], "type": "object" }, "premium_type": { "description": "Premium type, either the total premium, or just the employer-paid or employee-paid portion", "enum": [ "employee_amount", "employer_amount", "total_amount" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "amount", "billed_members", "carrier_id", "created", "effective_start_date", "id", "modified", "period", "premium_type", "version" ], "type": "object" }, "MemberQualifyingLifeEventDetails": { "properties": { "event_date": { "description": "ISO-8601 date string for qualifying life event date", "type": "string" }, "event_type": { "description": "Qualifying life event type", "enum": [ "adoption", "change_to_full_time", "change_to_part_time", "classifications_change", "court_order", "death", "dependent_open_enrollment", "divorce", "foster_care", "immigration_status_change", "legal_guardian", "lost_coverage", "marriage", "medicare", "moved", "newborn", "offline_change", "rate_changed", "rehire", "reinstatement" ], "type": "string" } }, "required": [ "event_date", "event_type" ], "type": "object" }, "MemberRemovingCoverage": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member removing coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is removing or canceling coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "MemberRequestCOBRAEnrollmentRequest": { "properties": { "coverages": { "description": "List of coverages being added or waived with a set of carriers", "items": { "$ref": "#/components/schemas/ApiBaseNewHireChangeCarrierCoverages", "description": "Information for a coverage being added or waived with each carrier" }, "minItems": 1, "type": "array" }, "termination_info": { "$ref": "#/components/schemas/PublicCOBRATerminationInfo", "description": "Termination info for the cobra member request" } }, "required": [ "coverages" ], "type": "object" }, "MemberRequestCOBRAOpenEnrollmentRequest": { "properties": { "coverages": { "description": "List of coverage change actions to complete with a set of carriers", "items": { "$ref": "#/components/schemas/ApiCOBRAOpenEnrollmentCarrierCoverages", "description": "Coverage change actions to complete with a carrier" }, "minItems": 1, "type": "array" }, "event": { "$ref": "#/components/schemas/ApiBaseOpenEnrollmentEventDetails", "description": "Details about the eligible open enrollment event" } }, "required": [ "coverages" ], "type": "object" }, "MemberRequestCOBRAQualifyingLifeEventRequest": { "properties": { "coverages": { "description": "List of coverage change actions to complete with a set of carriers", "items": { "$ref": "#/components/schemas/ApiCOBRAQualifyingLifeEventCarrierCoverages", "description": "Coverage change actions to complete with a carrier" }, "minItems": 1, "type": "array" }, "event": { "description": "Details about the eligible qualifying life event", "properties": { "event_date": { "description": "ISO-8601 date string for qualifying life event date", "type": "string" }, "event_type": { "description": "Qualifying life event type", "enum": [ "adoption", "change_to_full_time", "change_to_part_time", "classifications_change", "court_order", "death", "dependent_open_enrollment", "divorce", "foster_care", "immigration_status_change", "legal_guardian", "lost_coverage", "marriage", "medicare", "moved", "newborn", "offline_change", "override", "rate_changed", "rehire", "reinstatement", "terminate_cobra" ], "type": "string" } }, "required": [ "event_date", "event_type" ], "type": "object" } }, "required": [ "coverages", "event" ], "type": "object" }, "MemberRequestCOBRATerminationRequest": { "properties": { "cobra_termination_date": { "description": "The COBRA Termination event date.", "example": "2021-01-01", "type": "string" }, "reason": { "description": "Reason the member has removed or canceled COBRA coverage", "enum": [ "expiration", "involuntary", "medicare-entitlement", "new-enrollment", "non-payment", "voluntary" ], "type": "string" }, "signature_date": { "description": "ISO-8601 date string for signature date", "example": "2021-01-01", "type": "string" } }, "required": [ "cobra_termination_date", "reason" ], "type": "object" }, "MemberRequestDemographicChangeRequest": { "properties": { "change_date": { "description": "ISO-8601 date string for effective date of demographic change", "example": "2019-03-15", "type": "string" }, "member_changes": { "description": "List of employee or dependent demographic change actions", "items": { "$ref": "#/components/schemas/ApiBaseMemberDemographicChangeDetails", "description": "Employee or dependent demographic change details" }, "minItems": 1, "type": "array" }, "signature_date": { "description": "ISO-8601 date string for signature date", "type": "string" } }, "required": [ "member_changes" ], "type": "object" }, "MemberRequestEnrollmentSnapshotRequest": { "properties": { "coverages": { "description": "List of coverages being added or waived with a set of carriers", "items": { "$ref": "#/components/schemas/ApiBaseNewHireChangeCarrierCoverages", "description": "Information for a coverage being added or waived with each carrier" }, "minItems": 1, "type": "array" }, "enrollment_type": { "description": "Enrollment type of the enrollment snapshot member request", "enum": [ "new_hire" ], "type": "string" }, "target_date": { "description": "Date when the enrollment snapshot is effective", "type": "string" } }, "required": [ "coverages", "enrollment_type" ], "type": "object" }, "MemberRequestNewHireEnrollmentRequest": { "properties": { "coverages": { "description": "List of coverages being added or waived with a set of carriers", "items": { "$ref": "#/components/schemas/ApiBaseNewHireChangeCarrierCoverages", "description": "Information for a coverage being added or waived with each carrier" }, "minItems": 1, "type": "array" } }, "required": [ "coverages" ], "type": "object" }, "MemberRequestOpenEnrollmentRequest": { "properties": { "coverages": { "description": "List of coverage change actions to complete with a set of carriers", "items": { "$ref": "#/components/schemas/ApiOpenEnrollmentCarrierCoverages", "description": "Coverage change actions to complete with a carrier" }, "minItems": 1, "type": "array" }, "event": { "$ref": "#/components/schemas/ApiBaseOpenEnrollmentEventDetails", "description": "Details about the eligible open enrollment event" } }, "required": [ "coverages" ], "type": "object" }, "MemberRequestQualifyingLifeEventRequest": { "properties": { "coverages": { "description": "List of coverage change actions to complete with a set of carriers", "items": { "$ref": "#/components/schemas/ApiQualifyingLifeEventCarrierCoverages", "description": "Coverage change actions to complete with a carrier" }, "minItems": 1, "type": "array" }, "event": { "$ref": "#/components/schemas/ApiBaseQualifyingLifeEventDetails", "description": "Details about the eligible qualifying life event" } }, "required": [ "coverages", "event" ], "type": "object" }, "MemberRequestQueryRequest": { "properties": { "employee_id": { "description": "Unique identifier of the employee in Noyo to be filtered on", "format": "uuid", "type": "string" }, "group_id": { "description": "Unique identifier of the group in Noyo to be filtered on", "format": "uuid", "type": "string" }, "request_type": { "description": "Member request type to be filtered on", "enum": [ "cobra_enrollment", "cobra_open_enrollment", "cobra_qualifying_life_event", "cobra_termination", "demographic", "enrollment_snapshot", "new_hire", "open_enrollment", "qualifying_life_event", "termination" ], "type": "string" }, "status": { "description": "Status of the member request to be filtered on", "enum": [ "canceled", "completed", "failed", "processing" ], "type": "string" } }, "type": "object" }, "MemberRequestResult": { "properties": { "body": { "description": "Data required to execute a member request, varies depending on the request type", "type": "object" }, "completed": { "description": "Timestamp indicating when a member request was marked as completed", "readOnly": true, "type": "integer" }, "created": { "description": "The date the record was created", "type": "integer" }, "employee_id": { "description": "Unique identifier of the employee in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "request_type": { "description": "Transaction type for the member request", "enum": [ "cobra_enrollment", "cobra_open_enrollment", "cobra_qualifying_life_event", "cobra_termination", "demographic", "enrollment_snapshot", "new_hire", "open_enrollment", "qualifying_life_event", "termination" ], "type": "string" }, "result": { "description": "Result from executing the member request, varies depending on the request type", "type": "object" }, "status": { "description": "Status of the member request", "enum": [ "canceled", "completed", "failed", "processing" ], "type": "string" }, "transactions": { "description": "List of unique identifiers of all associated member transactions in Noyo", "items": { "format": "uuid", "type": "string" }, "type": "array" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "body", "created", "employee_id", "id", "modified", "request_type", "result", "status", "version" ], "type": "object" }, "MemberRequestResultEmpty": { "properties": {}, "type": "object" }, "MemberRequestResultFailed": { "properties": { "error": { "description": "Message describing the reason a member request failed", "type": "string" } }, "required": [ "error" ], "type": "object" }, "MemberRequestTerminationRequest": { "properties": { "last_work_date": { "description": "ISO-8601 date string for last day of work of the terminated employee", "example": "2019-03-04", "type": "string" }, "reason": { "description": "Reason for employee termination of coverage", "enum": [ "involuntary", "job-eliminated", "leave-of-absence", "loss-of-eligibility", "member-deceased", "military-leave", "voluntary" ], "example": "voluntary", "type": "string" }, "signature_date": { "description": "ISO-8601 date string for signature date", "type": "string" } }, "required": [ "last_work_date", "reason" ], "type": "object" }, "MemberSnapshotGroupQuery": { "properties": { "employee_id": { "description": "Unique ID of the employee in Noyo", "format": "uuid", "type": "string" } }, "type": "object" }, "MemberSnapshotResult": { "properties": { "created": { "description": "The date the record was created", "type": "integer" }, "employee_id": { "description": "Unique ID of the employee in Noyo", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "member_snapshot": { "description": "Member snapshot contents received from platform", "properties": { "coverages": { "description": "List of coverage and enrollment decisions for each members", "items": { "properties": { "carrier_config": { "description": "Details about enrolled member classifications at the carrier", "type": "object" }, "carrier_id": { "description": "Noyo Carrier ID associated with this coverage", "format": "uuid", "type": "string" }, "cobra_enrolled": { "description": "The boolean representation of whether or not this coverage is a cobra coverage", "type": "boolean" }, "enrolled_members": { "description": "Employee and dependent members enrolling in this coverage", "items": { "properties": { "custom_individual_id": { "description": "Platform ID of the employee or dependent from the snapshot", "nullable": true, "type": "string" }, "effective_end_date": { "description": "Effective end date of coverage for the member", "example": "9999-12-31", "format": "date", "type": "string" }, "effective_start_date": { "description": "Original effective start date of coverage for the member", "example": "2021-01-01", "format": "date", "type": "string" }, "event_id": { "description": "The unique ID of an event from the snapshot events list", "example": "1", "minLength": 1, "type": "string" }, "individual_id": { "description": "Unique ID of the employee or dependent from the snapshot", "format": "uuid", "nullable": true, "type": "string" }, "individual_type": { "description": "Type of member enrolling in coverage", "enum": [ "dependent", "employee" ], "example": "employee", "type": "string" }, "latest_change_effective_date": { "description": "Effective date of the latest change related to this member coverage", "example": "2022-01-01", "format": "date", "type": "string" }, "volume": { "description": "The volume of coverage for the member", "example": 100, "format": "int32", "type": "integer" } }, "required": [ "effective_end_date", "effective_start_date", "individual_type" ], "type": "object" }, "type": "array" }, "line_of_coverage": { "description": "Line of coverage for the coverage", "enum": [ "accident", "add", "cancer", "critical_illness", "dental", "hospital_indemnity", "life", "ltd", "medical", "std", "vision" ], "example": "dental", "type": "string" }, "plan_id": { "description": "The unique ID of the noyo plan associated with this coverage", "format": "uuid", "type": "string" }, "plan_name": { "description": "Platform plan name that maps to a group plan in Noyo", "minLength": 1, "type": "string" }, "signature_date": { "description": "The date the decision for this coverage enrollment was made", "example": "2020-01-01", "format": "date", "type": "string" } }, "required": [ "carrier_id", "enrolled_members", "line_of_coverage" ], "type": "object" }, "type": "array" }, "dependents": { "description": "List of demographic information for each dependent", "items": { "properties": { "custom_individual_id": { "description": "Custom ID of the Dependent from platform system. Required if member is new", "minLength": 1, "type": "string" }, "event_id": { "description": "The unique ID of an event from the snapshot events list", "example": "1", "minLength": 1, "type": "string" }, "id": { "description": "Unique ID of the Dependent in Noyo's system. Leave blank if member is new", "format": "uuid", "type": "string" }, "person": { "$ref": "#/components/schemas/PersonMemberSnapshotCreateRequest", "description": "Personal information for the employee" }, "relationship": { "description": "Relationship of the dependent to the employee", "enum": [ "adopted-child", "child", "civil-union", "domestic-partner", "ex-spouse", "foster-child", "grandchild", "legal-guardianship", "other", "spouse", "step-child" ], "type": "string" } }, "required": [ "person", "relationship" ], "type": "object" }, "type": "array" }, "employee": { "description": "Demographic information for the employee", "properties": { "classifications": { "description": "Fields that classify employees for group structure mapping", "type": "object" }, "custom_individual_id": { "description": "Custom ID of the Employee from platform system. Required if member is new", "minLength": 1, "type": "string" }, "employment": { "description": "Employment information for the employee", "properties": { "employment_dates": { "description": "Employee employment dates", "properties": { "full_time_start": { "description": "ISO-8601 date string for start date as a full time employee with the group (if applicable)", "example": "2017-01-17", "type": "string" }, "hire_date": { "description": "ISO-8601 date string for the hire date of the employee", "example": "2017-01-17", "format": "date", "type": "string" }, "rehire": { "description": "ISO-8601 date string for the rehire date of the employee (if applicable)", "example": "2018-02-01", "type": "string" }, "retirement": { "description": "ISO-8601 date string for the retirement date of the employee (if applicable)", "example": "2019-01-01", "type": "string" }, "terminated": { "description": "ISO-8601 date string for the termination date of the employee (if applicable)", "example": "2018-01-01", "type": "string" } }, "required": [ "hire_date" ], "type": "object" }, "employment_status": { "description": "Employee employment status", "enum": [ "contract", "disabled", "full-time", "part-time", "retired", "terminated" ], "type": "string" }, "hours_worked": { "description": "An integer of hours worked per week by the employee", "example": 40, "format": "int32", "type": "integer" }, "occupation": { "description": "Employee occupation or job title", "example": "Engineer", "type": "string" }, "salary": { "description": "Employee salary information", "properties": { "amount": { "description": "Amount of salary earned by the employee in US dollars and cents, as a decimal value", "example": 52000, "minimum": 0, "type": "number" }, "effective_date": { "description": "The ISO-8601 date-string the current employee salary is effective", "example": "2022-02-01", "type": "string" }, "type": { "description": "Type of salary earned by the employee", "enum": [ "hourly", "salary" ], "example": "salary", "type": "string" }, "unit": { "description": "Unit of salary earned by the employee", "enum": [ "annual", "hour", "month", "semi-monthly", "week" ], "example": "annual", "type": "string" } }, "type": "object" } }, "required": [ "employment_dates", "employment_status", "hours_worked" ], "type": "object" }, "event_id": { "description": "The unique ID of an event from the snapshot events list", "example": "1", "minLength": 1, "type": "string" }, "id": { "description": "Unique ID of the Employee in Noyo's system. Leave blank if member is new", "format": "uuid", "type": "string" }, "person": { "$ref": "#/components/schemas/PersonMemberSnapshotCreateRequest", "description": "Personal information for the employee" } }, "required": [ "employment", "person" ], "type": "object" }, "enable_member_auto_link": { "default": false, "description": "Boolean flag for autolinking workflow", "type": "boolean" }, "events": { "description": "List of events associates with member and coverage updates", "items": { "properties": { "date": { "description": "The date the event occurred", "format": "date", "type": "string" }, "id": { "description": "Unique ID for the event, used internally in this payload", "minLength": 1, "type": "string" }, "reason": { "description": "The cause or real world scenario described in the event", "enum": [ "adoption", "benefit_class_change", "change_to_full_time", "change_to_part_time", "cobra_enrollment", "cobra_termination", "cobra_update_other", "court_order", "death", "demographic_change", "dependent_open_enrollment", "disability_status_change", "divorce", "eligibility_change", "foster_care", "immigration_status_change", "leave_status_change", "legal_guardian", "lost_coverage", "marriage", "medicare", "moved", "new_hire", "newborn", "offline_change", "open_enrollment", "rate_changed", "rehire", "reinstatement", "retirement", "termination" ], "type": "string" }, "type": { "description": "The type or category of member change made due to this event", "enum": [ "coverage", "demographic" ], "type": "string" } }, "required": [ "date", "id", "reason", "type" ], "type": "object" }, "type": "array" }, "snapshot_mode": { "description": "Mode describing how the contents of the snapshot will be processed", "enum": [ "current_open" ], "example": "current_open", "type": "string" } }, "required": [ "employee", "snapshot_mode" ], "type": "object" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "status": { "description": "Status of the member snapshot", "enum": [ "completed", "failed", "processing", "replaced", "submitted" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" }, "warnings": { "description": "Warnings generated during processing of the member snapshot", "items": { "type": "string" }, "type": "array" } }, "required": [ "created", "employee_id", "id", "member_snapshot", "modified", "status", "version", "warnings" ], "type": "object" }, "MemberSnapshotWeb": { "properties": { "coverages": { "description": "List of coverage and enrollment decisions for each members", "items": { "properties": { "carrier_config": { "description": "Details about enrolled member classifications at the carrier", "type": "object" }, "carrier_id": { "description": "Noyo Carrier ID associated with this coverage", "format": "uuid", "type": "string" }, "cobra_enrolled": { "description": "The boolean representation of whether or not this coverage is a cobra coverage", "type": "boolean" }, "enrolled_members": { "description": "Employee and dependent members enrolling in this coverage", "items": { "properties": { "custom_individual_id": { "description": "Platform ID of the employee or dependent from the snapshot", "nullable": true, "type": "string" }, "effective_end_date": { "description": "Effective end date of coverage for the member", "example": "9999-12-31", "format": "date", "type": "string" }, "effective_start_date": { "description": "Original effective start date of coverage for the member", "example": "2021-01-01", "format": "date", "type": "string" }, "event_id": { "description": "The unique ID of an event from the snapshot events list", "example": "1", "minLength": 1, "type": "string" }, "individual_id": { "description": "Unique ID of the employee or dependent from the snapshot", "format": "uuid", "nullable": true, "type": "string" }, "individual_type": { "description": "Type of member enrolling in coverage", "enum": [ "dependent", "employee" ], "example": "employee", "type": "string" }, "latest_change_effective_date": { "description": "Effective date of the latest change related to this member coverage", "example": "2022-01-01", "format": "date", "type": "string" }, "volume": { "description": "The volume of coverage for the member", "example": 100, "format": "int32", "type": "integer" } }, "required": [ "effective_end_date", "effective_start_date", "individual_type" ], "type": "object" }, "type": "array" }, "line_of_coverage": { "description": "Line of coverage for the coverage", "enum": [ "medical", "dental", "vision", "life", "add", "std", "ltd", "accident", "critical_illness", "cancer", "hospital_indemnity" ], "example": "dental", "type": "string" }, "plan_id": { "description": "The unique ID of the noyo plan associated with this coverage", "format": "uuid", "type": "string" }, "plan_name": { "description": "Platform plan name that maps to a group plan in Noyo", "minLength": 1, "type": "string" }, "signature_date": { "description": "The date the decision for this coverage enrollment was made", "example": "2020-01-01", "format": "date", "type": "string" } }, "required": [ "carrier_id", "enrolled_members", "line_of_coverage" ], "type": "object" }, "type": "array" }, "dependents": { "description": "List of demographic information for each dependent", "items": { "properties": { "custom_individual_id": { "description": "Custom ID of the Dependent from platform system. Required if member is new", "minLength": 1, "type": "string" }, "event_id": { "description": "The unique ID of an event from the snapshot events list", "example": "1", "minLength": 1, "type": "string" }, "id": { "description": "Unique ID of the Dependent in Noyo's system. Leave blank if member is new", "format": "uuid", "type": "string" }, "person": { "$ref": "#/components/schemas/PersonMemberSnapshotCreateRequest", "description": "Personal information for the employee" }, "relationship": { "description": "Relationship of the dependent to the employee", "enum": [ "spouse", "child", "domestic-partner", "grandchild", "civil-union", "step-child", "foster-child", "adopted-child", "legal-guardianship", "ex-spouse", "other" ], "type": "string" } }, "required": [ "person", "relationship" ], "type": "object" }, "type": "array" }, "employee": { "description": "Demographic information for the employee", "properties": { "classifications": { "description": "Fields that classify employees for group structure mapping", "type": "object" }, "custom_individual_id": { "description": "Custom ID of the Employee from platform system. Required if member is new", "minLength": 1, "type": "string" }, "employment": { "description": "Employment information for the employee", "properties": { "employment_dates": { "description": "Employee employment dates", "properties": { "full_time_start": { "description": "ISO-8601 date string for start date as a full time employee with the group (if applicable)", "example": "2017-01-17", "type": "string" }, "hire_date": { "description": "ISO-8601 date string for the hire date of the employee", "example": "2017-01-17", "format": "date", "type": "string" }, "rehire": { "description": "ISO-8601 date string for the rehire date of the employee (if applicable)", "example": "2018-02-01", "type": "string" }, "retirement": { "description": "ISO-8601 date string for the retirement date of the employee (if applicable)", "example": "2019-01-01", "type": "string" }, "terminated": { "description": "ISO-8601 date string for the termination date of the employee (if applicable)", "example": "2018-01-01", "type": "string" } }, "required": [ "hire_date" ], "type": "object" }, "employment_status": { "description": "Employee employment status", "enum": [ "contract", "disabled", "full-time", "part-time", "retired", "terminated" ], "type": "string" }, "hours_worked": { "description": "An integer of hours worked per week by the employee", "example": 40, "format": "int32", "type": "integer" }, "occupation": { "description": "Employee occupation or job title", "example": "Engineer", "type": "string" }, "salary": { "description": "Employee salary information", "properties": { "amount": { "description": "Amount of salary earned by the employee in US dollars and cents, as a decimal value", "example": 52000, "minimum": 0, "type": "number" }, "effective_date": { "description": "The ISO-8601 date-string the current employee salary is effective", "example": "2022-02-01", "type": "string" }, "type": { "description": "Type of salary earned by the employee", "enum": [ "hourly", "salary" ], "example": "salary", "type": "string" }, "unit": { "description": "Unit of salary earned by the employee", "enum": [ "annual", "hour", "month", "semi-monthly", "week" ], "example": "annual", "type": "string" } }, "type": "object" } }, "required": [ "employment_dates", "employment_status", "hours_worked" ], "type": "object" }, "event_id": { "description": "The unique ID of an event from the snapshot events list", "example": "1", "minLength": 1, "type": "string" }, "id": { "description": "Unique ID of the Employee in Noyo's system. Leave blank if member is new", "format": "uuid", "type": "string" }, "person": { "$ref": "#/components/schemas/PersonMemberSnapshotCreateRequest", "description": "Personal information for the employee" } }, "required": [ "employment", "person" ], "type": "object" }, "enable_member_auto_link": { "default": false, "description": "Boolean flag for autolinking workflow", "type": "boolean" }, "events": { "description": "List of events associates with member and coverage updates", "items": { "properties": { "date": { "description": "The date the event occurred", "format": "date", "type": "string" }, "id": { "description": "Unique ID for the event, used internally in this payload", "minLength": 1, "type": "string" }, "reason": { "description": "The cause or real world scenario described in the event", "enum": [ "adoption", "benefit_class_change", "change_to_part_time", "change_to_full_time", "cobra_enrollment", "cobra_termination", "cobra_update_other", "court_order", "death", "demographic_change", "dependent_open_enrollment", "disability_status_change", "divorce", "eligibility_change", "foster_care", "immigration_status_change", "leave_status_change", "legal_guardian", "lost_coverage", "marriage", "medicare", "moved", "newborn", "new_hire", "offline_change", "open_enrollment", "rate_changed", "rehire", "reinstatement", "retirement", "termination" ], "type": "string" }, "type": { "description": "The type or category of member change made due to this event", "enum": [ "coverage", "demographic" ], "type": "string" } }, "required": [ "date", "id", "reason", "type" ], "type": "object" }, "type": "array" }, "snapshot_mode": { "description": "Mode describing how the contents of the snapshot will be processed", "enum": [ "current_open" ], "example": "current_open", "type": "string" } }, "required": [ "employee", "snapshot_mode" ], "type": "object" }, "MemberTransactionResult": { "properties": { "body": { "description": "Body of the member transaction", "type": "object" }, "carrier_id": { "description": "Unique identifier of the carrier in the Noyo system", "format": "uuid", "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "employee_id": { "description": "Unique identifier of the associated employee in the Noyo system", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "lines_of_coverage": { "description": "List of lines of coverage for the member transaction", "items": { "description": "Line of coverage for the member transaction", "enum": [ "accident", "add", "cancer", "critical_illness", "dental", "hospital_indemnity", "life", "ltd", "medical", "std", "vision" ], "type": "string" }, "minItems": 1, "type": "array" }, "member_request_id": { "description": "Unique identifier of the member request in the Noyo system", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "result": { "description": "Result of the member transaction", "type": "object" }, "status": { "description": "Status of the member transaction", "enum": [ "canceled", "completed", "failed", "processing" ], "type": "string" }, "status_details": { "description": "History of status details for the member transaction", "items": { "$ref": "#/components/schemas/StatusDetailResult" }, "type": "array" }, "transaction_type": { "description": "Transaction type of the member transaction", "enum": [ "carrier_cobra_enrollment", "carrier_cobra_open_enrollment", "carrier_cobra_qualifying_life_event", "carrier_cobra_termination", "carrier_demographic", "carrier_demographic_full", "carrier_enrollment_snapshot_new_hire", "carrier_new_hire", "carrier_open_enrollment_adding", "carrier_open_enrollment_full", "carrier_open_enrollment_modifying", "carrier_open_enrollment_removing", "carrier_qualifying_life_event_adding", "carrier_qualifying_life_event_full", "carrier_qualifying_life_event_modifying", "carrier_qualifying_life_event_removing", "carrier_termination", "noyo_termination" ], "type": "string" }, "ui_body": { "description": "A restructured form of the transaction's body data for UI display purposes", "type": "string" }, "verified": { "description": "The date the member transaction was verified", "type": "integer" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "body", "created", "employee_id", "id", "lines_of_coverage", "member_request_id", "modified", "result", "status", "transaction_type", "version" ], "type": "object" }, "MemberTransactionResultEmpty": { "properties": {}, "type": "object" }, "MemberTransactionResultFailed": { "properties": { "error": { "description": "Message describing the reason a member transaction failed", "type": "string" } }, "required": [ "error" ], "type": "object" }, "MemberWaivingCoverage": { "properties": { "id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "type": "string" }, "member_type": { "description": "Type of member waiving coverage", "enum": [ "dependent", "employee" ], "type": "string" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "type": "string" }, "reason": { "description": "Reason the member is waiving coverage", "enum": [ "medi-cal", "medicaid", "no-coverage", "other-cobra", "other-employee-group", "other-ind-off-exchange", "other-ind-on-exchange", "other-medicare", "other-parent-group", "other-spouse-group", "retiree-coverage", "tricare-coverage", "va-coverage", "voluntary-withdrawal" ], "type": "string" } }, "required": [ "id", "member_type", "reason" ], "type": "object" }, "NewGroupSetupRequestResult": { "properties": { "group_data": { "description": "Additional data required to process the new group setup", "properties": {}, "readOnly": true, "type": "object" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the new group setup request in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "request_type": { "description": "Type of the new group setup request", "readOnly": true, "type": "string" }, "setup_result": { "description": "Result after completing a new group setup request", "properties": {}, "readOnly": true, "type": "object" }, "status": { "description": "Status of the group setup request", "readOnly": true, "type": "string" } }, "required": [ "group_data", "group_id", "id", "request_type", "setup_result", "status" ], "type": "object" }, "PaginatedContactResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of contact results", "items": { "$ref": "#/components/schemas/ContactResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedDependentResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of dependent results", "items": { "$ref": "#/components/schemas/DependentResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedDiscrepancyNoteResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of discrepancy notes", "items": { "$ref": "#/components/schemas/DiscrepancyNoteResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedEmployeeResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of employee results", "items": { "$ref": "#/components/schemas/EmployeeResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedGroupCoverageExportResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of group coverage exports", "items": { "$ref": "#/components/schemas/GroupCoverageExportResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedGroupDisconnectionRequestResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of group disconnection request results", "items": { "$ref": "#/components/schemas/GroupDisconnectionRequestResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedGroupEnrollmentResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of group enrollment results", "items": { "$ref": "#/components/schemas/GroupEnrollmentPublicResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedGroupPlanResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of group plan results", "items": { "description": "Group plan associated with the group", "readOnly": true, "type": "object" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedGroupResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of group results", "items": { "$ref": "#/components/schemas/GroupResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedGroupSetupRequestPublicResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of group connection results", "items": { "$ref": "#/components/schemas/GroupSetupRequestPublicResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedIndividualEnrollmentResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of individual enrollment results", "items": { "$ref": "#/components/schemas/PublicIndividualEnrollmentResultWithConfig" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedLocationResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of location results", "items": { "$ref": "#/components/schemas/LocationResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedMemberPremiumResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of member premiums", "items": { "$ref": "#/components/schemas/MemberPremiumResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedMemberRequestResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of member request results", "items": { "$ref": "#/components/schemas/MemberRequestResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedMemberSnapshotResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of member snapshot results", "items": { "properties": { "created": { "description": "The date the record was created", "type": "integer" }, "employee_id": { "description": "Unique identifier of the employee in Noyo", "format": "uuid", "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "status": { "description": "Status of the member snapshot", "enum": [ "processing", "completed", "replaced", "failed", "submitted" ], "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "created", "employee_id", "id", "modified", "status", "version" ], "type": "object" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedMemberTransactionResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of member transaction results", "items": { "$ref": "#/components/schemas/MemberTransactionResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedReconciliationIssuePublicResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of reconciliation issue results", "items": { "$ref": "#/components/schemas/ReconciliationIssuePublicResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedReconciliationIssueResolutionResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of reconciliation issue resolutions", "items": { "$ref": "#/components/schemas/ReconciliationIssueResolutionResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedRenewalDecisionByGroupRequest": { "properties": { "renewal_date": { "description": "The start date for the new enrollment year when all coverage changes and decisions should become active", "format": "date", "type": "string" } }, "type": "object" }, "PaginatedRenewalDecisionResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of renewal decisions", "items": { "$ref": "#/components/schemas/RenewalDecisionResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedRenewalDecisionsRequest": { "properties": { "group_name": { "description": "Group Name for the group related to the open enrollment period", "type": "string" }, "status": { "description": "Calculated status based on whether or not the carrier system matches the expected renewal decisions", "type": "string" } }, "type": "object" }, "PaginatedStatusDetailResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of status detail results", "items": { "$ref": "#/components/schemas/StatusDetailResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "PaginatedUIGroupMappableFieldsResult": { "properties": { "meta": { "description": "Metadata associated with the response data", "properties": { "offset": { "description": "The offset of the first response record within the matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" }, "page_num": { "description": "The page number of the response records within the overall data set (1-based integer)", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "page_size": { "description": "The maximum number of response records on each page of results", "format": "int32", "minimum": 1, "readOnly": true, "type": "integer" }, "total_records": { "description": "The total number of records in the entire matching data set", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "offset", "page_num", "page_size", "total_records" ], "type": "object" }, "response": { "description": "List of mappable fields", "items": { "$ref": "#/components/schemas/UIGroupMappableFieldsResult" }, "type": "array" } }, "required": [ "meta", "response" ], "type": "object" }, "Person": { "properties": { "contact": { "$ref": "#/components/schemas/PersonContact", "description": "Contact information for the person" }, "date_of_birth": { "description": "ISO-8601 date string for the date of birth of the person", "example": "1977-06-03", "format": "date", "type": "string" }, "details": { "$ref": "#/components/schemas/PersonDetails", "description": "Additional personal details of the person" }, "first_name": { "description": "First name of the person", "example": "Catherine", "type": "string" }, "home_address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Home address of the person", "nullable": true }, "last_name": { "description": "Last name of the person", "example": "Briggs", "type": "string" }, "maiden_name": { "description": "Maiden name of the person (deprecated)", "type": "string" }, "mailing_address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Mailing address of the person, if different from home address", "nullable": true }, "marital_status": { "description": "Marital status of the person", "enum": [ "divorced", "domestic-partner", "legally-separated", "married", "single", "widowed" ], "example": "married", "type": "string" }, "middle_name": { "description": "Middle name of the person", "example": "S", "type": "string" }, "sex": { "description": "Sex of the person", "enum": [ "F", "M", "U", "X" ], "example": "F", "type": "string" }, "ssn": { "description": "Social Security Number of the person", "example": "123456789", "nullable": true, "type": "string" }, "suffix": { "description": "Suffix of the person", "type": "string" } }, "required": [ "date_of_birth", "first_name", "home_address", "last_name", "sex" ], "type": "object" }, "PersonContact": { "properties": { "email_address": { "description": "Email address of the person", "example": "catherine.briggs@example.com", "format": "email", "type": "string" }, "email_address_type": { "description": "Type of email address", "enum": [ "home", "work" ], "example": "home", "type": "string" }, "home_phone": { "description": "Home phone number in E.164 format", "example": "+15555551212", "type": "string" }, "preferred_language": { "description": "Preferred written or spoken language of the person", "example": "Engish", "type": "string" }, "preferred_method": { "description": "Preferred method of contact for the person", "enum": [ "email", "home-phone", "mail", "other", "work-phone" ], "example": "email", "type": "string" }, "speaks_english": { "description": "True if the person can speak or communicate in English", "example": true, "type": "boolean" }, "work_phone": { "description": "Work phone number in E.164 format", "example": "+15555551212", "type": "string" } }, "type": "object" }, "PersonDetails": { "properties": { "american_indian": { "description": "American Indian status details (if applicable)", "properties": { "state": { "description": "Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable", "enum": [ "AK", "AL", "AR", "AS", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "FM", "GA", "GU", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MH", "MI", "MN", "MO", "MP", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OH", "OK", "OR", "PA", "PR", "PW", "RI", "SC", "SD", "TN", "TX", "UM", "UT", "VA", "VI", "VT", "WA", "WI", "WV", "WY" ], "type": "string" }, "tribe": { "description": "Name of the federally-recognized American Indian or Alaska Native tribe, if applicable", "example": "Ojibwe", "type": "string" } }, "type": "object" }, "disability": { "$ref": "#/components/schemas/PersonDisability", "description": "Disability details (if applicable)" }, "is_military": { "description": "True if the person is in the military", "type": "boolean" }, "is_student": { "description": "True if the person is a student", "type": "boolean" }, "tobacco": { "$ref": "#/components/schemas/PersonTobacco", "description": "Tobacco usage details (if applicable)" } }, "type": "object" }, "PersonDisability": { "properties": { "communication": { "description": "True if the disability impacts the ability to communicate or read", "type": "boolean" }, "disabled": { "description": "True if the member has a disability", "type": "boolean" }, "reason": { "description": "Description of the disability", "type": "string" } }, "type": "object" }, "PersonMemberSnapshotCreateRequest": { "properties": { "contact": { "description": "Contact information for the person", "properties": { "email_address": { "description": "Email address of the person", "example": "catherine.briggs@example.com", "format": "email", "nullable": true, "type": "string" }, "email_address_type": { "description": "Type of email address", "enum": [ "home", "work" ], "example": "home", "type": "string" }, "home_phone": { "description": "Home phone number in E.164 format", "example": "+15555551212", "type": "string" }, "preferred_language": { "description": "Preferred written or spoken language of the person", "example": "Engish", "type": "string" }, "preferred_method": { "description": "Preferred method of contact for the person", "enum": [ "email", "home-phone", "mail", "other", "work-phone" ], "example": "email", "type": "string" }, "speaks_english": { "description": "True if the person can speak or communicate in English", "example": true, "type": "boolean" }, "work_phone": { "description": "Work phone number in E.164 format", "example": "+15555551212", "type": "string" } }, "type": "object" }, "date_of_birth": { "description": "ISO-8601 date string for the date of birth of the person", "example": "1977-06-03", "format": "date", "type": "string" }, "details": { "$ref": "#/components/schemas/PersonDetails", "description": "Additional personal details of the person" }, "first_name": { "description": "First name of the person", "example": "Catherine", "type": "string" }, "home_address": { "$ref": "#/components/schemas/Address", "description": "Home address of the person" }, "last_name": { "description": "Last name of the person", "example": "Briggs", "type": "string" }, "maiden_name": { "description": "Maiden name of the person (deprecated)", "type": "string" }, "mailing_address": { "$ref": "#/components/schemas/Address", "description": "Mailing address of the person, if different from home address" }, "marital_status": { "description": "Marital status of the person", "enum": [ "divorced", "domestic-partner", "legally-separated", "married", "single", "widowed" ], "example": "married", "type": "string" }, "middle_name": { "description": "Middle name of the person", "example": "S", "type": "string" }, "sex": { "description": "Sex of the person", "enum": [ "F", "M", "U", "X" ], "example": "F", "type": "string" }, "ssn": { "description": "Social Security Number of the person", "example": "123456789", "nullable": true, "type": "string" }, "suffix": { "description": "Suffix of the person", "type": "string" } }, "required": [ "date_of_birth", "first_name", "home_address", "last_name", "mailing_address", "sex" ], "type": "object" }, "PersonTobacco": { "properties": { "duration": { "description": "Duration of tobacco use", "example": "5 years", "type": "string" }, "frequency": { "description": "Frequency of tobacco use", "example": "Daily", "type": "string" }, "types": { "description": "List of types of tobacco use", "example": "cigarettes", "items": { "enum": [ "chewing-tobacco", "cigarettes", "pipe" ], "type": "string" }, "minItems": 1, "type": "array" }, "user": { "description": "True if the person uses tobacco of any kind", "example": true, "type": "boolean" } }, "type": "object" }, "PlatformAccountStructureAccountStructureField": { "properties": { "existing_value_set": { "description": "All distinct values that are represented in the group for this field", "items": { "type": "string" }, "type": "array" }, "field_name": { "description": "The name of the field", "type": "string" }, "field_type": { "description": "The data type of this field", "enum": [ "boolean", "date", "decimal", "integer", "string" ], "type": "string" } }, "required": [ "existing_value_set", "field_name", "field_type" ], "type": "object" }, "PlatformAccountStructureAccountStructurePlan": { "properties": { "group_accident_plans": { "description": "List of accident plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_add_plans": { "description": "List of AD&D plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_cancer_plans": { "description": "List of cancer plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_critical_illness_plans": { "description": "List of critical illness plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_dental_plans": { "description": "List of dental plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_hospital_indemnity_plans": { "description": "List of hospital indemnity plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_life_plans": { "description": "List of life plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_ltd_plans": { "description": "List of long-term disability plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_medical_plans": { "description": "List of medical plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_std_plans": { "description": "List of short-term disability plan names for the group", "items": { "type": "string" }, "type": "array" }, "group_vision_plans": { "description": "List of vision plan names for the group", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "PlatformAccountStructureCreateRequest": { "properties": { "account_structure": { "description": "Group-specific platform account structure", "properties": { "account_structure_fields": { "items": { "$ref": "#/components/schemas/PlatformAccountStructureAccountStructureField" }, "type": "array" }, "plans": { "$ref": "#/components/schemas/PlatformAccountStructureAccountStructurePlan", "description": "Plans available for plan mapping" } }, "type": "object" }, "end_date": { "description": "Effective end date of the record", "example": "2020-01-01", "format": "date", "type": "string" }, "start_date": { "description": "Effective start date of the record, defaults to today", "example": "2019-01-01", "format": "date", "type": "string" } }, "required": [ "account_structure" ], "type": "object" }, "PlatformAccountStructureEditRequest": { "properties": { "account_structure": { "description": "Group-specific platform account structure", "properties": { "account_structure_fields": { "items": { "$ref": "#/components/schemas/PlatformAccountStructureAccountStructureField" }, "type": "array" }, "plans": { "$ref": "#/components/schemas/PlatformAccountStructureAccountStructurePlan", "description": "Plans available for plan mapping" } }, "type": "object" }, "effective_date": { "description": "Effective date for target record to update, defaults to today", "example": "2019-04-04", "format": "date", "type": "string" } }, "required": [ "account_structure" ], "type": "object" }, "PlatformAccountStructureQueryRequest": { "properties": { "effective_date": { "description": "Effective date for target record to query, defaults to today", "example": "2019-04-04", "format": "date", "type": "string" } }, "type": "object" }, "PlatformAccountStructureResult": { "properties": { "account_structure": { "description": "Group-specific platform account structure", "properties": { "account_structure_fields": { "items": { "$ref": "#/components/schemas/PlatformAccountStructureAccountStructureField" }, "type": "array" }, "plans": { "$ref": "#/components/schemas/PlatformAccountStructureAccountStructurePlan", "description": "Plans available for plan mapping" } }, "readOnly": true, "type": "object" }, "created": { "description": "The date the record was created", "type": "integer" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "account_structure", "created", "group_id", "id", "modified", "version" ], "type": "object" }, "PublicCOBRATerminationInfo": { "properties": { "last_work_date": { "description": "ISO-8601 date string for last day of work of the terminated employee", "example": "2020-12-15", "type": "string" }, "reason": { "description": "Reason for member coverage termination and enrollment in COBRA", "enum": [ "involuntary", "job-eliminated", "leave-of-absence", "loss-of-eligibility", "member-deceased", "military-leave", "voluntary" ], "type": "string" } }, "required": [ "last_work_date", "reason" ], "type": "object" }, "PublicGroupCarrierConfigurationResult": { "properties": { "carrier_group_id": { "description": "Unique identifier for the group in the carrier system", "readOnly": true, "type": "string" }, "carrier_id": { "description": "Unique identifier of the carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "configuration": { "description": "Carrier configuration details for the group", "readOnly": true, "type": "object" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "readOnly": true, "type": "string" } }, "required": [ "carrier_group_id", "carrier_id", "configuration", "group_id" ], "type": "object" }, "PublicIndividualEnrollmentResultWithConfig": { "properties": { "cobra_enrollment": { "description": "Details about the member COBRA enrollment status, if applicable", "properties": { "cobra_enrolled": { "description": "True if member is enrolled in COBRA coverage", "type": "boolean" }, "cobra_type": { "description": "Type of COBRA enrollment for the member", "enum": [ "federal", "state" ], "type": "string" } }, "readOnly": true, "type": "object" }, "created": { "description": "The date the record was created", "type": "integer" }, "effective_end_date": { "description": "ISO-8601 date string for the effective date of the coverage", "example": "2017-01-17", "format": "date", "type": "string" }, "effective_start_date": { "description": "ISO-8601 date string for the effective date of the coverage", "example": "2017-01-17", "format": "date", "type": "string" }, "enroll_data": { "description": "Line of coverage specific enroll data with volume information", "readOnly": true, "type": "object" }, "group_enrollment_id": { "description": "Unique identifier of the group enrollment in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "individual_enrollment_configuration": { "description": "Carrier-specific details describing the individual enrollment configuration", "readOnly": true, "type": "object" }, "individual_id": { "description": "Unique identifier of the employee or dependent in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "individual_type": { "description": "Type of member for the individual enrollment", "enum": [ "dependent", "employee" ], "example": "employee", "readOnly": true, "type": "string" }, "line_of_coverage": { "description": "Line of coverage for the individual enrollment", "enum": [ "accident", "add", "cancer", "critical_illness", "dental", "hospital_indemnity", "life", "ltd", "medical", "std", "vision" ], "example": "dental", "readOnly": true, "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "plan_id": { "description": "Unique identifier of the group plan in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "status": { "description": "Status of the individual enrollment", "enum": [ "active", "pending", "terminated", "waived" ], "example": "active", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "cobra_enrollment", "created", "enroll_data", "group_enrollment_id", "id", "individual_enrollment_configuration", "individual_id", "individual_type", "line_of_coverage", "modified", "plan_id", "status", "version" ], "type": "object" }, "ReconciliationIssueAckRequest": { "properties": {}, "type": "object" }, "ReconciliationIssuePublicResult": { "properties": { "body": { "description": "Details of what values are in contention with each other", "readOnly": true, "type": "object" }, "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "context": { "description": "Context for the processing of the reconciliation issue", "readOnly": true, "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "reconciliation_issue_type": { "description": "Categorization of the reconciliation issue", "readOnly": true, "type": "string" }, "status": { "description": "Status of the reconciliation issue", "enum": [ "dismissed", "failed", "needs_review", "processing", "resolved" ], "readOnly": true, "type": "string" }, "subject_id": { "description": "Unique identifier of the model that is the subject of the reconciliation issue", "format": "uuid", "readOnly": true, "type": "string" }, "subject_type": { "description": "The type of the model that is the subject of the reconciliation issue", "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "body", "carrier_id", "created", "group_id", "id", "modified", "reconciliation_issue_type", "status", "subject_id", "subject_type", "version" ], "type": "object" }, "ReconciliationIssueResolutionRequestOutcome": { "properties": { "distributor_action": { "description": "The distributor action taken to sync up with Noyo's system, as a result of this change", "enum": [ "already_updated", "no_update", "will_update" ], "example": "already_updated", "type": "string" }, "outcome": { "description": "The chosen response to take, after being notified of the reconciliation issue", "enum": [ "carrier_change", "distributor_change", "no_change", "noyo_change" ], "example": "carrier_value", "type": "string" }, "request_context": { "description": "Additional context to provide when requesting an outcome", "example": "Our records reflect that they should be enrolled at the carrier, can you update?", "type": "string" }, "resolution_type": { "description": "The technique used to resolve the reconciliation issue", "enum": [ "member_request", "no_action", "offline" ], "example": "offline", "type": "string" } }, "required": [ "outcome" ], "type": "object" }, "ReconciliationIssueResolutionResult": { "properties": { "automated_change_id": { "description": "Unique identifier of the associated automated change model", "format": "uuid", "readOnly": true, "type": "string" }, "automated_change_type": { "description": "The type or model of the associated automated change, 'MemberRequest' or 'MemberSnapshot'", "enum": [ "member_request", "member_snapshot", "no_change" ], "readOnly": true, "type": "string" }, "created": { "description": "The date the record was created", "type": "integer" }, "distributor_action": { "description": "The distributor action taken to sync up with Noyo's system, as a result of this change", "example": "already_updated", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "outcome": { "description": "The outcome of the resolution, in order words, what change took place", "example": "carrier_change", "readOnly": true, "type": "string" }, "reconciliation_issue_id": { "description": "Unique identifier of the associated reconciliation issue", "format": "uuid", "readOnly": true, "type": "string" }, "request_context": { "description": "Additional context provided by the distributor when requesting an outcome", "example": "Our records reflect that they should be enrolled at the carrier, can you update?", "readOnly": true, "type": "string" }, "resolution_type": { "description": "The technique used to resolve the reconciliation issue", "example": "member_request", "readOnly": true, "type": "string" }, "result": { "description": "Result of the discrepancy resolution", "type": "object" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "created", "distributor_action", "id", "modified", "reconciliation_issue_id", "request_context", "resolution_type", "version" ], "type": "object" }, "RenewalDecisionADDLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to ADD plans", "items": { "$ref": "#/components/schemas/RenewalDecisionADDPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionADDPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionAccidentLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to accident plans", "items": { "$ref": "#/components/schemas/RenewalDecisionAccidentPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionAccidentPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionCancerLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to cancer plans", "items": { "$ref": "#/components/schemas/RenewalDecisionCancerPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionCancerPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionCarrier": { "properties": { "carrier_id": { "description": "Unique identifier of the carrier in Noyo", "format": "uuid", "type": "string" }, "lines_of_coverage": { "$ref": "#/components/schemas/RenewalDecisionLinesOfCoverage", "description": "Expected open enrollment information for each line of coverage" } }, "required": [ "carrier_id" ], "type": "object" }, "RenewalDecisionCreateRequest": { "properties": { "body": { "description": "The carrier and coverage expectations for the open enrollment period", "properties": { "carriers": { "description": "Carrier-specific open enrollment information", "items": { "$ref": "#/components/schemas/RenewalDecisionCarrier" }, "minItems": 1, "type": "array" } }, "required": [ "carriers" ], "type": "object" }, "renewal_date": { "description": "The start date for the new enrollment year when all coverages should be active", "format": "date", "type": "string" } }, "required": [ "body", "renewal_date" ], "type": "object" }, "RenewalDecisionCriticalIllnessLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to critical illness plans", "items": { "$ref": "#/components/schemas/RenewalDecisionCriticalIllnessPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionCriticalIllnessPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionDentalLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to dental plans", "items": { "$ref": "#/components/schemas/RenewalDecisionDentalPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionDentalPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionEditRequest": { "properties": { "body": { "description": "The carrier and coverage expectations for the open enrollment period", "properties": { "carriers": { "description": "Carrier-specific open enrollment information", "items": { "$ref": "#/components/schemas/RenewalDecisionCarrier" }, "minItems": 1, "type": "array" } }, "required": [ "carriers" ], "type": "object" }, "renewal_date": { "description": "The start date for the new enrollment year when all coverage changes and decisions should become active", "format": "date", "type": "string" } }, "type": "object" }, "RenewalDecisionHospitalIndemnityLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to hospital indemnity plans", "items": { "$ref": "#/components/schemas/RenewalDecisionHospitalIndemnityPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionHospitalIndemnityPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionIssue": { "properties": { "carrier_id": { "description": "Unique identifier of the associated carrier in Noyo", "format": "uuid", "type": "string" }, "level": { "description": "The level or severity of the issue found", "enum": [ "error", "warning" ], "type": "string" }, "line_of_coverage": { "description": "Line of coverage related to the issue", "type": "string" }, "message": { "description": "Message describing the issue found and any steps to resolve", "type": "string" } }, "required": [ "level", "message" ], "type": "object" }, "RenewalDecisionLTDLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to LTD plans", "items": { "$ref": "#/components/schemas/RenewalDecisionLTDPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionLTDPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionLifeLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to life plans", "items": { "$ref": "#/components/schemas/RenewalDecisionLifePlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionLifePlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionLinesOfCoverage": { "properties": { "accident": { "$ref": "#/components/schemas/RenewalDecisionAccidentLOC", "description": "Open enrollment information relating to accident plans" }, "add": { "$ref": "#/components/schemas/RenewalDecisionADDLOC", "description": "Open enrollment information relating to AD&D plans" }, "cancer": { "$ref": "#/components/schemas/RenewalDecisionCancerLOC", "description": "Open enrollment information relating to cancer plans" }, "critical_illness": { "$ref": "#/components/schemas/RenewalDecisionCriticalIllnessLOC", "description": "Open enrollment information relating to critical illness plans" }, "dental": { "$ref": "#/components/schemas/RenewalDecisionDentalLOC", "description": "Open enrollment information relating to dental plans" }, "hospital_indemnity": { "$ref": "#/components/schemas/RenewalDecisionHospitalIndemnityLOC", "description": "Open enrollment information relating to hospital indemnity plans" }, "life": { "$ref": "#/components/schemas/RenewalDecisionLifeLOC", "description": "Open enrollment information relating to life plans" }, "ltd": { "$ref": "#/components/schemas/RenewalDecisionLTDLOC", "description": "Open enrollment information relating to LTD plans" }, "medical": { "$ref": "#/components/schemas/RenewalDecisionMedicalLOC", "description": "Open enrollment information relating to medical plans" }, "std": { "$ref": "#/components/schemas/RenewalDecisionSTDLOC", "description": "Open enrollment information relating to STD plans" }, "vision": { "$ref": "#/components/schemas/RenewalDecisionVisionLOC", "description": "Open enrollment information relating to vision plans" } }, "type": "object" }, "RenewalDecisionMedicalLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to medical plans", "items": { "$ref": "#/components/schemas/RenewalDecisionMedicalPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionMedicalPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionResult": { "properties": { "body": { "description": "The carrier and coverage expectations for the open enrollment period", "properties": { "carriers": { "description": "Carrier-specific open enrollment information", "items": { "$ref": "#/components/schemas/RenewalDecisionCarrier" }, "minItems": 1, "type": "array" } }, "required": [ "carriers" ], "type": "object" }, "created": { "description": "The date the record was created", "type": "integer" }, "group_id": { "description": "Unique identifier of the group in Noyo", "format": "uuid", "readOnly": true, "type": "string" }, "id": { "description": "Unique identifier of the record in Noyo", "format": "uuid", "type": "string" }, "issues": { "description": "List of any issues that explain why the open enrollment is 'not_ready'. Will be empty if it is status 'ready' or 'submitted'.", "items": { "$ref": "#/components/schemas/RenewalDecisionIssue" }, "type": "array" }, "modified": { "description": "The date the record was last updated", "type": "integer" }, "renewal_date": { "description": "The start date for the new enrollment year when all coverage changes and decisions should become active", "format": "date", "readOnly": true, "type": "string" }, "status": { "description": "Calculated status based on whether or not the carrier system matches the expected renewal decisions", "enum": [ "not_ready", "ready", "submitted" ], "readOnly": true, "type": "string" }, "version": { "description": "Current version of the record", "format": "uuid", "type": "string" } }, "required": [ "body", "created", "group_id", "id", "issues", "modified", "renewal_date", "status", "version" ], "type": "object" }, "RenewalDecisionSTDLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to STD plans", "items": { "$ref": "#/components/schemas/RenewalDecisionSTDPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionSTDPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "RenewalDecisionVisionLOC": { "properties": { "open_enrollment_end_date": { "description": "ISO-8601 date string for the end of the open enrollment period when member requests and changes can be processed", "example": "2022-02-01", "format": "date", "type": "string" }, "open_enrollment_start_date": { "description": "ISO-8601 date string for the start of the open enrollment period when member requests and changes can be processed", "example": "2022-01-01", "format": "date", "type": "string" }, "plans": { "description": "Open enrollment information related to vision plans", "items": { "$ref": "#/components/schemas/RenewalDecisionVisionPlan" }, "minItems": 1, "type": "array" } }, "type": "object" }, "RenewalDecisionVisionPlan": { "properties": { "name": { "description": "Name of the group plan", "type": "string" }, "plan_id": { "description": "Unique ID of a group plan that exists in the Noyo system", "format": "uuid", "type": "string" } }, "type": "object" }, "Salary": { "properties": { "amount": { "description": "Amount of salary earned by the employee in US dollars and cents, as a decimal value", "example": 52000, "minimum": 0, "type": "number" }, "type": { "description": "Type of salary earned by the employee", "enum": [ "hourly", "salary" ], "example": "salary", "type": "string" }, "unit": { "description": "Unit of salary earned by the employee", "enum": [ "annual", "hour", "month", "semi-monthly", "week" ], "example": "annual", "type": "string" } }, "type": "object" }, "SingleGroupPlanResult": { "properties": { "plan": { "description": "Group plan associated to a line of coverage", "readOnly": true, "type": "object" } }, "required": [ "plan" ], "type": "object" }, "StatusDetailResult": { "properties": { "event_created": { "description": "Timestamp indicating when the status detail was created", "example": "1673452723", "type": "integer" }, "status_detail": { "description": "Type of Status detail", "enum": [ "carrier_accepted", "carrier_completed", "carrier_processing", "noyo_accepted", "noyo_verified" ], "example": "carrier_accepted", "type": "string" } }, "required": [ "event_created", "status_detail" ], "type": "object" } } }, "info": { "description": "Policy management APIs for health and ancillary insurance", "title": "Noyo Fulfillment API", "version": "1.0.0" }, "openapi": "3.0.1", "paths": { "/api/v1/dependents/{dependent_id}": { "get": { "description": "Returns the latest version of a single dependent based on the ID provided.", "operationId": "getDependent", "parameters": [ { "description": "The unique identifier of the dependent you would like to view", "in": "path", "name": "dependent_id", "required": true, "schema": { "example": "fd62665c-0846-4e9d-bd29-80779b5f685c", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "modified": 1547412389, "person": { "contact": { "email_address": "diane@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1982-01-02", "first_name": "Diane", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "sex": "F", "ssn": "987654321" }, "relationship": "spouse", "version": "669fbe16-9960-4069-91aa-832ada3f4e42" }, "schema": { "$ref": "#/components/schemas/DependentResult" } } }, "description": "Successful Response - Returns a single Dependent" } }, "summary": "Get a single Dependent", "tags": [ "Group Configuration" ] }, "x-summary": "Get Single Dependent" }, "/api/v1/dependents/{dependent_id}/individual_enrollments": { "get": { "description": "Returns a list of all individual enrollments for a given dependent.", "operationId": "getIndividualEnrollmentByDependentList", "parameters": [ { "description": "The unique identifier of the employee for which you would like to view individual enrollments", "in": "path", "name": "dependent_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "cobra_enrollment": {}, "created": 1557512389, "effective_end_date": "2019-10-01", "effective_start_date": "2018-10-01", "enroll_data": { "premium": { "amount": 50, "unit": "Month" } }, "group_enrollment_id": "7499ea07-76c9-40f2-992b-952259e98384", "id": "6670f290-4236-4690-bece-a110f9ad924b", "individual_enrollment_configuration": {}, "individual_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "individual_type": "dependent", "line_of_coverage": "medical", "modified": 1564440756, "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a", "status": "active", "version": "27bbf929-78ca-4339-8bb3-39b75f92c4a4" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedIndividualEnrollmentResult" } } }, "description": "Successful Response - Returns all matching Individual Enrollments" } }, "summary": "Get a list of all Individual Enrollments for a Dependent", "tags": [ "Individual Enrollments" ] }, "x-summary": "Get All Individual Enrollments for a Dependent" }, "/api/v1/discrepancies/{discrepancy_id}/notes": { "get": { "description": "Returns a list of all notes for a given discrepancy.", "operationId": "getDiscrepancyNotesList", "parameters": [ { "description": "The unique identifier of the discrepancy for which you would like to view notes", "in": "path", "name": "discrepancy_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "author_type": "noyo", "content": "This discrepancy is associated with 5 others that will be sent over soon.", "discrepancy_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedDiscrepancyNoteResult" } } }, "description": "Successful Response - Returns all matching discrepancy notes" } }, "summary": "Get a list of all discrepancy notes under a single discrepancy", "tags": [ "Discrepancies" ] }, "x-summary": "Get a list of discrepancy notes" }, "/api/v1/employees": { "get": { "description": "If there is a use case where you need to query employees across all the groups in your organization you can do so using this endpoint. Returns a list of all employees under your organization, regardless of group.", "operationId": "getEmployeeList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "The employee first name for which you would like to filter", "in": "query", "name": "first_name", "required": false, "schema": { "type": "string" } }, { "description": "The employee last name for which you would like to filter", "in": "query", "name": "last_name", "required": false, "schema": { "type": "string" } }, { "description": "The employee's name for which you would like to filter", "in": "query", "name": "name", "required": false, "schema": { "type": "string" } }, { "description": "The ISO-8601 (YYYY-MM-DD) employee date of birth for which you would like to filter", "in": "query", "name": "date_of_birth", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "type": "salary", "unit": "annual" }, "work_state": "CA" }, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1981-06-22", "first_name": "David", "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": "M", "ssn": "123456789" }, "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedEmployeeResult" } } }, "description": "Successful Response - Returns all matching Employees" } }, "summary": "Get a list of all Employees", "tags": [ "Group Configuration" ] }, "post": { "description": "Create a new employee for a group.", "operationId": "createEmployee", "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "classifications": { "BranchName": "HQ" }, "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "type": "salary", "unit": "annual" }, "work_state": "CA" }, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1981-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "sex": "M", "ssn": "123456789" } } } }, "schema": { "$ref": "#/components/schemas/EmployeeCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "classifications": { "BranchName": "HQ" }, "created": 1626281253, "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "type": "salary", "unit": "annual" } }, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "modified": 1626281253, "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1981-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "sex": "M", "ssn": "123456789" }, "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" }, "schema": { "$ref": "#/components/schemas/EmployeeResult" } } }, "description": "Successful Response - Returns the new Employee" } }, "summary": "Create a new Employee", "tags": [ "Group Configuration" ] }, "x-summary": "Create New Employee" }, "/api/v1/employees/{employee_id}": { "get": { "description": "Returns the latest version of a single employee based on the ID provided.", "operationId": "getEmployee", "parameters": [ { "description": "The unique identifier of the employee you would like to view", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "type": "salary", "unit": "annual" }, "work_state": "CA" }, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1981-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "", "sex": "M", "ssn": "123456789" }, "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" }, "schema": { "$ref": "#/components/schemas/EmployeeResult" } } }, "description": "Successful Response - Returns a single Employee" } }, "summary": "Get a single Employee", "tags": [ "Group Configuration" ] }, "x-summary": "Get Single Employee" }, "/api/v1/employees/{employee_id}/dependents": { "get": { "description": "Returns a list of all dependents for a given employee.", "operationId": "getDependentList", "parameters": [ { "description": "The unique identifier of the employee for which you would like to view dependents", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "modified": 1547412389, "person": { "contact": { "email_address": "diane@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1982-01-02", "first_name": "Diane", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "", "sex": "F", "ssn": "987654321" }, "relationship": "spouse", "version": "669fbe16-9960-4069-91aa-832ada3f4e42" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedDependentResult" } } }, "description": "Successful Response - Returns all matching Dependents" } }, "summary": "List All Dependents", "tags": [ "Group Configuration" ] }, "post": { "description": "Create a new dependent for an employee.", "operationId": "createDependent", "parameters": [ { "description": "The unique identifier of the employee the dependent belongs to", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "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" } } }, "schema": { "$ref": "#/components/schemas/DependentCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "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" }, "schema": { "$ref": "#/components/schemas/DependentResult" } } }, "description": "Successful Response - Returns the new Dependent" } }, "summary": "Create a new Dependent", "tags": [ "Group Configuration" ] }, "x-summary": "Dependents" }, "/api/v1/employees/{employee_id}/dependents/{dependent_id}": { "get": { "description": "Returns the latest version of a single dependent of an employee based on the ID provided.", "operationId": "getEmployeeDependent", "parameters": [ { "description": "The unique identifier of the employee the dependent belongs to", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the dependent you would like to view", "in": "path", "name": "dependent_id", "required": true, "schema": { "example": "fd62665c-0846-4e9d-bd29-80779b5f685c", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "modified": 1547412389, "person": { "contact": { "email_address": "diane@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1982-01-02", "first_name": "Diane", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "", "sex": "F", "ssn": "987654321" }, "relationship": "spouse", "version": "669fbe16-9960-4069-91aa-832ada3f4e42" }, "schema": { "$ref": "#/components/schemas/DependentResult" } } }, "description": "Successful Response - Returns a single Dependent" } }, "summary": "Get a single Dependent of Employee", "tags": [ "Group Configuration" ] }, "x-summary": "Get Single Dependent of Employee" }, "/api/v1/employees/{employee_id}/individual_enrollments": { "get": { "description": "Returns a list of all individual enrollments for a given employee.", "operationId": "getIndividualEnrollmentByEmployeeList", "parameters": [ { "description": "The unique identifier of the employee for which you would like to view individual enrollments", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } }, { "description": "Boolean, use \"true\" to include dependent individual enrollments in the results", "in": "query", "name": "include_dependents", "required": false, "schema": { "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "cobra_enrollment": {}, "created": 1557512389, "effective_end_date": "2019-10-01", "effective_start_date": "2018-10-01", "enroll_data": { "premium": { "amount": 50, "unit": "Month" } }, "group_enrollment_id": "7499ea07-76c9-40f2-992b-952259e98384", "id": "6670f290-4236-4690-bece-a110f9ad924b", "individual_enrollment_configuration": {}, "individual_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "individual_type": "employee", "line_of_coverage": "medical", "modified": 1564440756, "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a", "status": "active", "version": "27bbf929-78ca-4339-8bb3-39b75f92c4a4" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedIndividualEnrollmentResult" } } }, "description": "Successful Response - Returns all matching Individual Enrollments" } }, "summary": "Get a list of all Individual Enrollments for an Employee", "tags": [ "Individual Enrollments" ] }, "x-summary": "Get All Individual Enrollments for an Employee" }, "/api/v1/employees/{employee_id}/member_requests": { "get": { "description": "Returns a list of all member requests for a given employee. Each member request may have one or more associated member transactions.", "operationId": "getEmployeeMemberRequestList", "parameters": [ { "description": "The unique identifier of the employee for which you would like to view member requests", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "body": { "coverages": [ { "carrier_config": { "bill_group": "1000001", "member_group": "99999" }, "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16", "lines_of_coverage": { "dental": { "waiving_members": [ { "id": "f471a562-fa8f-41c9-93fd-12b372e16c72", "member_type": "employee", "reason": "other-spouse-group" } ] } } } ] }, "completed": 1557565200, "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5", "modified": 1557565200, "request_type": "new_hire", "status": "processing", "transactions": [ "a6e30204-87b2-4802-95a4-a156bd0f7435" ] }, { "body": { "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "last_work_date": "2018-01-15", "reason": "voluntary" }, "completed": 1557565200, "created": 1557512394, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557565200, "request_type": "termination", "status": "processing", "transactions": [ "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd" ] } ] }, "schema": { "$ref": "#/components/schemas/PaginatedMemberRequestResult" } } }, "description": "Successful Response - Returns all matching Member Requests" } }, "summary": "Get all Member Requests for Employee", "tags": [ "Member Requests" ] }, "x-summary": "List Member Requests" }, "/api/v1/employees/{employee_id}/member_requests/cobra_enrollment": { "post": { "description": "The COBRA enrollment member request is used to add an existing employee, and optionally their dependents to multiple coverages at multiple carriers. This is for a continuation of benefits situation, when main line coverage either has already been terminated, or will be in conjunction with this member request.\n", "operationId": "cobraEnrollmentMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "A COBRA Enrollment request with employee and dependent enrollment actions", "value": { "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" } ], "termination_info": { "last_work_date": "2020-01-01", "reason": "voluntary" } } } }, "schema": { "$ref": "#/components/schemas/MemberRequestCOBRAEnrollmentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "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" } ], "termination_info": { "last_work_date": "2020-01-01", "reason": "voluntary" } }, "created": 1557512389, "employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea", "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5", "modified": 1564440756, "request_type": "cobra_enrollment", "result": {}, "status": "processing", "transactions": [ "a6e30204-87b2-4802-95a4-a156bd0f7435" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a COBRA Enrollment Member Request", "tags": [ "Member Requests" ] }, "x-summary": "COBRA Emrollment" }, "/api/v1/employees/{employee_id}/member_requests/cobra_open_enrollment": { "post": { "description": "The COBRA open enrollment member request is used to make changes to employees, dependents and COBRA coverages during the open enrollment period.", "operationId": "cobraOpenEnrollmentMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "Member request to add COBRA coverage to a dependent during the open enrollment period.", "value": { "coverages": [ { "carrier_config": {}, "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9", "lines_of_coverage": { "medical": { "adding_coverage": [ { "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "member_type": "dependent", "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a" } ] } }, "signature_date": "2021-01-15" } ] } } }, "schema": { "$ref": "#/components/schemas/MemberRequestCOBRAOpenEnrollmentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "body": { "coverages": [ { "carrier_config": {}, "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9", "lines_of_coverage": { "medical": { "adding_coverage": [ { "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "member_type": "dependent", "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a" } ] } }, "signature_date": "2021-01-15" } ] }, "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "f4517b87-275a-42e1-85e5-47ea6ab5312b", "modified": 1564440756, "request_type": "cobra_open_enrollment", "status": "processing", "transactions": [ "579952dd-9a66-4587-a4f7-72a63bf9ec86" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a COBRA Open Enrollment Member Request", "tags": [ "Member Requests" ] }, "x-summary": "COBRA Open Enrollment" }, "/api/v1/employees/{employee_id}/member_requests/cobra_qualifying_life_event": { "post": { "description": "The COBRA qualifying life event member request is used to make changes to employees, dependents and COBRA coverages due to a qualifying life event.", "operationId": "cobraQualifyingLifeEventMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "A COBRA Qualifying Life Event member request with employee and dependent enrollment actions", "value": { "coverages": [ { "carrier_config": {}, "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9", "lines_of_coverage": { "medical": { "adding_coverage": [ { "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "member_type": "dependent", "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a" } ] } }, "signature_date": "2021-01-15" } ], "event": { "event_date": "2021-01-01", "event_type": "newborn" } } } }, "schema": { "$ref": "#/components/schemas/MemberRequestCOBRAQualifyingLifeEventRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "body": { "coverages": [ { "carrier_config": {}, "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9", "lines_of_coverage": { "medical": { "adding_coverage": [ { "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "member_type": "dependent", "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a" } ] } }, "signature_date": "2021-01-15" } ], "event": { "event_date": "2021-01-01", "event_type": "newborn" } }, "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "f4517b87-275a-42e1-85e5-47ea6ab5312b", "modified": 1564440756, "request_type": "cobra_qualifying_life_event", "status": "processing", "transactions": [ "579952dd-9a66-4587-a4f7-72a63bf9ec86" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a COBRA Qualifying Life Event Member Request", "tags": [ "Member Requests" ] }, "x-summary": "COBRA Qualifying Life Event" }, "/api/v1/employees/{employee_id}/member_requests/cobra_termination": { "post": { "description": "The COBRA termination member request is used to remove an employee and their dependents from COBRA coverage at all carriers. The `cobra_termination_date` is the date on which the COBRA coverage should be terminated.", "operationId": "cobraTerminationMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "Member Request to successfully terminate an employee from COBRA", "value": { "cobra_termination_date": "2021-01-15", "reason": "voluntary", "signature_date": "2021-01-01" } } }, "schema": { "$ref": "#/components/schemas/MemberRequestCOBRATerminationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "body": { "cobra_termination_date": "2021-01-15", "reason": "voluntary", "signature_date": "2021-01-01" }, "created": 1557512389, "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1564440756, "request_type": "cobra_termination", "status": "processing", "transactions": [ "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a COBRA Termination Member Request", "tags": [ "Member Requests" ] }, "x-summary": "COBRA Termination" }, "/api/v1/employees/{employee_id}/member_requests/demographic": { "post": { "description": "The demographic change member request is used to update information such as name, address, and salary for one or many members. The updates will be carried out for each carrier that has a record of each member.", "operationId": "demographicChangeMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "change_date": "2020-01-15", "member_changes": [ { "contact_change": { "email_address": "david.williamson@example.com", "email_address_type": "home", "home_phone": "+15555551212", "work_phone": "+15555551212" }, "member": { "id": "f471a562-fa8f-41c9-93fd-12b372e16c72", "type": "employee" }, "name_change": { "first_name": "David", "last_name": "Williamson" }, "salary_change": { "amount": 55000, "type": "salary", "unit": "annual" } } ], "signature_date": "2020-01-15" } } }, "schema": { "$ref": "#/components/schemas/MemberRequestDemographicChangeRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "body": { "change_date": "2020-01-15", "member_changes": [ { "contact_change": { "email_address": "david.williamson@example.com", "email_address_type": "home", "home_phone": "+15555551212", "work_phone": "+15555551212" }, "member": { "id": "f471a562-fa8f-41c9-93fd-12b372e16c72", "member_type": "employee" }, "name_change": { "first_name": "David", "last_name": "Williamson" }, "salary_change": { "amount": 55000, "type": "salary", "unit": "annual" } } ], "signature_date": "2020-01-15" }, "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "db6f362a-9f90-49b2-a73d-830cd2726537", "modified": 1564440756, "request_type": "demographic", "status": "processing", "transactions": [ "b56bfe70-2632-49e9-b269-1eaa36ed7fd6" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a Demographic Change Member Request", "tags": [ "Member Requests" ] }, "x-summary": "Demographic Change Member Request" }, "/api/v1/employees/{employee_id}/member_requests/enrollment_snapshot": { "post": { "description": "The Enrollment Snapshot Member Request allows you to communicate the desired state of an employee's coverage elections during an employee's new hire period. You can use it in one of two cases:\n\n* To enroll an employee and their dependents for the first time. Please reference the [New Hire Enrollment](#new-hire-enrollment) documentation section for more details.\n* To amend and replace a previous New Hire member request with the latest complete set of coverage elections, described in this section below.\n", "operationId": "createEnrollmentSnapshotMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "An Enrollment Snapshot request with employee and dependents enrolling or waiving", "value": { "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" } ], "enrollment_type": "new_hire" } } }, "schema": { "$ref": "#/components/schemas/MemberRequestEnrollmentSnapshotRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "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" } ], "enrollment_type": "new_hire" }, "created": 1557512389, "employee_id": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea", "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5", "modified": 1564440756, "request_type": "enrollment_snapshot", "result": {}, "status": "processing", "transactions": [ "a6e30204-87b2-4802-95a4-a156bd0f7435" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create an Enrollment Snapshot Member Request", "tags": [ "Member Requests" ] }, "x-summary": "Enrollment Snapshot" }, "/api/v1/employees/{employee_id}/member_requests/new_hire": { "post": { "description": "The new hire member request is used to add an existing employee, and optionally their dependents to multiple coverages at multiple carriers.", "operationId": "newHireEnrollmentMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "72af10df-a8b3-46f1-a114-ac36d4b8a6ea", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "A New Hire Enrollment request with employee and dependents enrolling", "value": { "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" } ] } } }, "schema": { "$ref": "#/components/schemas/MemberRequestNewHireEnrollmentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "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" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a New Hire Enrollment Member Request", "tags": [ "Member Requests" ] }, "x-summary": "New Hire Enrollment Member Request" }, "/api/v1/employees/{employee_id}/member_requests/open_enrollment": { "post": { "description": "The open enrollment member request is used to make changes to existing employees, dependents and coverages during the open enrollment period.", "operationId": "openEnrollmentMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "coverages": [ { "carrier_config": {}, "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9", "created": 1557512389, "lines_of_coverage": { "medical": { "adding_coverage": [ { "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "member_type": "dependent", "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a" } ] } }, "modified": 1564440756, "signature_date": "2022-01-15" } ] } } }, "schema": { "$ref": "#/components/schemas/MemberRequestOpenEnrollmentRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "body": { "coverages": [ { "carrier_config": {}, "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9", "lines_of_coverage": { "medical": { "adding_coverage": [ { "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "member_type": "dependent", "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a" } ] } }, "signature_date": "2022-01-15" } ] }, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "f4517b87-275a-42e1-85e5-47ea6ab5312b", "request_type": "open_enrollment", "status": "processing", "transactions": [ "579952dd-9a66-4587-a4f7-72a63bf9ec86" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a Open Enrollment Member Request", "tags": [ "Member Requests" ] }, "x-summary": "Open Enrollment Member Request" }, "/api/v1/employees/{employee_id}/member_requests/qualifying_life_event": { "post": { "description": "The qualifying life event member request is used to make changes to existing employees, dependents and coverages due to a qualifying life event.", "operationId": "qualifyingLifeEventMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "coverages": [ { "carrier_config": {}, "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9", "created": 1557512389, "lines_of_coverage": { "medical": { "adding_coverage": [ { "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "member_type": "dependent", "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a" } ] } }, "modified": 1564440756, "signature_date": "2020-01-15" } ], "event": { "event_date": "2020-01-01", "event_type": "newborn" } } } }, "schema": { "$ref": "#/components/schemas/MemberRequestQualifyingLifeEventRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "body": { "coverages": [ { "carrier_config": {}, "carrier_id": "9a0a7437-4097-4251-9e71-85384c0eb1c9", "lines_of_coverage": { "medical": { "adding_coverage": [ { "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "member_type": "dependent", "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a" } ] } }, "signature_date": "2020-01-15" } ], "event": { "event_date": "2020-01-01", "event_type": "newborn" } }, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "f4517b87-275a-42e1-85e5-47ea6ab5312b", "request_type": "qualifying_life_event", "status": "processing", "transactions": [ "579952dd-9a66-4587-a4f7-72a63bf9ec86" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a Qualifying Life Event Member Request", "tags": [ "Member Requests" ] }, "x-summary": "Qualifying Life Event Member Request" }, "/api/v1/employees/{employee_id}/member_requests/termination": { "post": { "description": "The `termination` member request is used to remove an employee and their dependents from coverage at all carriers. The `last_work_date` will be communicated to the carrier and the `last_day_of_coverage` will be determined by the carrier and included in the result.", "operationId": "terminationMemberRequest", "parameters": [ { "description": "The unique identifier of the employee related to the member request", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "Member Request to successfully terminate an employee", "value": { "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "last_work_date": "2020-01-15", "reason": "voluntary", "signature_date": "2020-01-01" } } }, "schema": { "$ref": "#/components/schemas/MemberRequestTerminationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "body": { "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "last_work_date": "2020-01-15", "reason": "voluntary", "signature_date": "2020-01-01" }, "created": 1557512389, "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1564440756, "request_type": "termination", "status": "processing", "transactions": [ "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns the new Member Request" } }, "summary": "Create a Termination Member Request", "tags": [ "Member Requests" ] }, "x-summary": "Termination Member Request" }, "/api/v1/employees/{employee_id}/member_snapshot": { "get": { "description": "Get a Member Snapshot by Employee ID. This will be calculated based on the current state of Noyo data for the employee.", "operationId": "getMemberSnapshotForEmployee", "parameters": [ { "description": "The unique identifier of the employee", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "coverages": [ { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "cobra_enrolled": true, "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "individual_type": "employee", "latest_change_effective_date": "2022-02-13" }, { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "9da3ea58-73fc-4a99-82c3-489bb4a4c1d4", "individual_type": "dependent" } ], "line_of_coverage": "medical", "plan_id": "4bf04f73-0aad-48ac-b28a-e5f4def7c5e9", "signature_date": "2021-12-23" }, { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_type": "employee" }, { "effective_end_date": "2021-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "9da3ea58-73fc-4a99-82c3-489bb4a4c1d4", "individual_type": "dependent" } ], "line_of_coverage": "dental", "plan_name": "DHMO Smile Plus", "signature_date": "2021-12-23" }, { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_type": "employee", "volume": 50000 } ], "line_of_coverage": "life", "plan_name": "50k Employee Basic Life", "signature_date": "2021-12-23" } ], "dependents": [ { "event_id": "1", "id": "ab740704-7c37-4010-92b3-d22c6926be3e", "person": { "contact": { "email_address": "jamie@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1990-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": "married", "sex": "F", "ssn": "987654321" }, "relationship": "spouse" } ], "employee": { "classifications": { "BranchName": "HQ", "Department": "Sales" }, "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "effective_date": "2022-01-31", "type": "salary", "unit": "annual" } }, "event_id": "1", "group_id": "d0ec3837-3499-4a2f-8c58-966ef7e46d95", "id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1985-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "middle_name": "A", "sex": "M", "ssn": "123456789", "suffix": "Jr" } }, "events": [ { "date": "2022-01-01", "id": "1", "reason": "open_enrollment", "type": "enrollment" } ], "snapshot_mode": "current_open" }, "schema": { "$ref": "#/components/schemas/MemberSnapshotWeb" } } }, "description": "Successful Response - Returns the Member Snapshot contents for an employee" } }, "summary": "Get a Member Snapshot by Employee", "tags": [ "Member Snapshot" ] }, "x-summary": "Get a single employees member snapshot" }, "/api/v1/employees/{employee_id}/member_snapshots": { "get": { "description": "Returns a list with metadata for all member snapshots for a given employee.", "operationId": "getMemberSnapshotsForEmployeeList", "parameters": [ { "description": "The unique identifier of the employee for which you would like to view member snapshots", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "created": 1599184829, "employee_id": "7f39b5e0-460d-49e2-83b7-a1b6f2726b12", "id": "bc4aea3e-f728-4b05-85dc-e1ea14456e83", "modified": 1599184829, "status": "processing", "version": "431b7d10-3da6-4c5e-bb2f-58a6ebb1224f" }, { "created": 1557512389, "employee_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "modified": 1564440756, "status": "completed", "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedMemberSnapshotResult" } } }, "description": "Successful Response - Returns metadata for any matching Member Snapshots" } }, "summary": "Get all Member Snapshots by Employee", "tags": [ "Member Snapshot" ] } }, "/api/v1/employees/{employee_id}/premiums": { "get": { "description": "Returns list of Member Premium information for an employee and dependents", "operationId": "getMemberPremiumsByEmployeeId", "parameters": [ { "description": "Unique ID of the employee in Noyo", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the records. Defaults to today", "in": "query", "name": "effective_date", "required": false, "schema": { "example": "Tue, 01 Sep 2020 00:00:00 GMT", "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "amount": "50.00", "billed_members": [ { "line_of_coverage": "dental", "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3", "member_type": "employee", "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea" }, { "line_of_coverage": "vision", "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3", "member_type": "employee", "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0" }, { "line_of_coverage": "dental", "member_id": "67309c4b-12f5-4bb0-92ce-a45639af9055", "member_type": "dependent", "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea" }, { "line_of_coverage": "vision", "member_id": "8f5aaf65-c4e6-4909-9ebf-58b320645df2", "member_type": "dependent", "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0" } ], "carrier_id": "e2c76400-b505-432a-a1c1-c777bcec4648", "created": 1599184829, "effective_end_date": "2020-12-31", "effective_start_date": "2020-01-01", "modified": 1599292817, "period": { "amount": 1, "unit": "month" }, "premium_type": "employer_amount" }, { "amount": "50.00", "billed_members": [ { "line_of_coverage": "dental", "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3", "member_type": "employee", "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea" }, { "line_of_coverage": "vision", "member_id": "4638b93f-b20a-4922-82b1-0f406891e2e3", "member_type": "employee", "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0" }, { "line_of_coverage": "dental", "member_id": "67309c4b-12f5-4bb0-92ce-a45639af9055", "member_type": "dependent", "plan_id": "8609ee91-772a-4047-8e2b-a79883cf05ea" }, { "line_of_coverage": "vision", "member_id": "8f5aaf65-c4e6-4909-9ebf-58b320645df2", "member_type": "dependent", "plan_id": "e1793d34-700b-4c14-9425-d0f4f426d4d0" } ], "carrier_id": "e2c76400-b505-432a-a1c1-c777bcec4648", "created": 1599184829, "effective_end_date": "2020-12-31", "effective_start_date": "2020-01-01", "modified": 1599292817, "period": { "amount": 1, "unit": "month" }, "premium_type": "employee_amount" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedMemberPremiumResult" } } }, "description": "Paginated List of Member Premiums" } }, "summary": "Get a list of all Member Premiums", "tags": [ "Member Premiums" ] }, "x-summary": "Get Premiums for a single employee and family" }, "/api/v1/employees/{employee_id}/status": { "get": { "description": "Returns the status of the employee and family, summarized by carrier and including any pending or completed enrollment changes requested by the platform.", "operationId": "getEmployeeStatus", "parameters": [ { "description": "The unique identifier of the employee", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "pending_changes": { "value": { "carrier_statuses": [ { "carrier_id": "1012fbfe-3fbf-422b-807c-b449a3119a61", "pending_changes": [ { "id": "6e0d7cf3-e8a8-42a1-b2dc-269fa988b99e", "status": "processing", "type": "member_snapshot" } ], "status": "pending_changes" } ] } }, "stable": { "value": { "carrier_statuses": [ { "carrier_id": "1012fbfe-3fbf-422b-807c-b449a3119a61", "latest_platform_change": { "id": "6e0d7cf3-e8a8-42a1-b2dc-269fa988b99e", "status": "completed", "type": "member_snapshot" }, "pending_changes": [], "status": "stable" } ] } }, "unable_to_fulfill": { "value": { "carrier_statuses": [ { "carrier_id": "1012fbfe-3fbf-422b-807c-b449a3119a61", "latest_platform_change": { "error": { "message": "Salary effective date needed for volume change" }, "id": "c39ccd04-b4ef-4a5f-b267-c32c83fa50fa", "status": "failed", "type": "member_snapshot" }, "pending_changes": [], "status": "unable_to_fulfill" } ] } } }, "schema": { "$ref": "#/components/schemas/EmployeeStatusResult" } } }, "description": "Returns details about the current status of the Employee" } }, "summary": "Get Employee Status", "tags": [ "Member Snapshot" ] }, "x-summary": "Get Current Employee Status compared to Snapshots" }, "/api/v1/group_connections": { "get": { "description": "Returns a list of all group connections.", "operationId": "getGroupConnectionRequestList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "Status of the group connection for which you would like to filter. Multiple statuses can be used, separated by a comma.", "in": "query", "name": "status", "schema": { "type": "string" } }, { "description": "The unique identifier of the carrier for which you would like to view group connection requests", "in": "query", "name": "carrier_id", "required": false, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the organization for which you would like to view group connection requests", "in": "query", "name": "organization_id", "required": false, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The attribute on which to sort the group connections", "in": "query", "name": "sort_by", "required": false, "schema": { "type": "string" } }, { "description": "Either asc or desc, to denote the data's direction", "in": "query", "name": "sort_direction", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "completed": 1557392400, "created": 1557329939, "group_data": { "carrier_group_id": "10000000", "group_name": "Test Company" }, "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557392400, "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "request_type": "initial", "status": "processing", "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupSetupRequestPublicResult" } } }, "description": "Successful Response - Returns all matching Group Connection Requests" } }, "summary": "List Group Connections", "tags": [ "Group Connections" ] }, "post": { "description": "Create a new connection for a brand new group with a given carrier", "operationId": "createGroupConnection", "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "federal_ein": "123456789", "group_data": { "carrier_group_id": "10000000", "group_name": "Test Company" } } } }, "schema": { "$ref": "#/components/schemas/GroupSetupRequestPublicAPICreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "created": 1557329939, "group_data": { "carrier_group_id": "10000000", "group_name": "Test Company" }, "group_id": "47c07963-2e34-4da2-86b4-cbc3c57111c1", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "request_type": "initial", "status": "created", "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b" }, "schema": { "$ref": "#/components/schemas/GroupSetupRequestResult" } } }, "description": "Successful Response - Returns the new Group Connection" } }, "summary": "Create a new Group Connection", "tags": [ "Group Connections" ] } }, "/api/v1/group_connections/{connection_id}": { "get": { "description": "Returns the latest status of a single group connection based on the ID provided.", "operationId": "getGroupConnection", "parameters": [ { "description": "The unique identifier of the group connection you would like to view", "in": "path", "name": "connection_id", "required": true, "schema": { "example": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "completed": 1557392400, "created": 1557329939, "group_data": { "carrier_group_id": "10000000", "group_name": "Test Company" }, "group_id": "9e629e41-c706-4efd-9fbb-1ff2573fc67e", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557392400, "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "request_type": "initial", "setup_result": {}, "status": "completed", "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b" }, "schema": { "$ref": "#/components/schemas/GroupSetupRequestPublicResult" } } }, "description": "Successful Response - Returns a single Group Connection" } }, "summary": "Get a single Group Connection", "tags": [ "Group Connections" ] } }, "/api/v1/group_connections/{connection_id}/retry": { "put": { "description": "Retry a carrier connection for an existing group", "operationId": "retryGroupConnectionWithExistingGroup", "parameters": [ { "description": "The unique identifier of the group connection that needs to be reprocessed", "in": "path", "name": "connection_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "carrier_group_id": "10000001" } } }, "schema": { "$ref": "#/components/schemas/GroupSetupRequestPublicAPIRetryRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "created": 1667866198, "group_data": { "carrier_group_id": "10000001" }, "group_id": "47c07963-2e34-4da2-86b4-cbc3c57111c1", "id": "5e20ea6a-8027-464a-941a-867c115c846d", "modified": 1667866198, "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "request_type": "incremental", "status": "processing", "version": "608c6f37-5945-4987-b247-0b5acdf85034" }, "schema": { "$ref": "#/components/schemas/GroupSetupRequestPublicResult" } } }, "description": "Successful Response - Returns the updated Group Connection" } }, "summary": "Retry an existing group connection for an existing group", "tags": [ "Group Connections" ] } }, "/api/v1/group_coverage_exports": { "get": { "description": "Get all relevant group coverage exports", "operationId": "getGroupCoverageExportList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "as_of": "2023-01-31", "carrier_ids": [ "8fac0992-933a-4743-8dab-0d606ef2569e" ], "completed": null, "created": 1675199964, "expires": null, "file_format": "csv", "file_key": "csv-uploads/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/2023-02-01-test-group-coverage-export.xlsx", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "0620e171-5dcc-4f2b-9143-6c96a5ee9925", "modified": 1675199964, "percentage_complete": 0, "request_user_id": "00112806-bd97-442d-8884-83e71c3de057", "status": "processing", "version": "f5133f0a-30ae-443a-80f0-9975abec3213" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupCoverageExportResult" } } }, "description": "Successful Response - Returns Group Coverage Exports" } }, "summary": "Get a list of all Group Coverage Exports", "tags": [ "Group Coverage Export" ] } }, "/api/v1/group_coverage_exports/{group_coverage_export_id}": { "get": { "description": "Get a Group Coverage Export by ID", "operationId": "getGroupCoverageExport", "parameters": [ { "description": "The unique identifier of the group coverage export", "in": "path", "name": "group_coverage_export_id", "required": true, "schema": { "example": "0620e171-5dcc-4f2b-9143-6c96a5ee9925", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "as_of": "2023-01-31", "carrier_ids": [ "8fac0992-933a-4743-8dab-0d606ef2569e" ], "completed": null, "created": 1675199964, "expires": null, "file_format": "csv", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "0620e171-5dcc-4f2b-9143-6c96a5ee9925", "modified": 1675199964, "percentage_complete": 0, "request_user_id": "00112806-bd97-442d-8884-83e71c3de057", "status": "processing", "version": "f5133f0a-30ae-443a-80f0-9975abec3213" }, "schema": { "$ref": "#/components/schemas/GroupCoverageExportResult" } } }, "description": "Successful Response - Returns the Group Coverage Export contents" } }, "summary": "Get a Group Coverage Export", "tags": [ "Group Coverage Export" ] }, "x-summary": "Get a single group coverage export" }, "/api/v1/group_coverage_exports/{group_coverage_export_id}/file": { "get": { "description": "Returns file contents for a group coverage export", "operationId": "getGroupCoverageExportFile", "parameters": [ { "description": "The unique identifier of the group coverage export", "in": "path", "name": "group_coverage_export_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "text/csv": { "example": "Member Type,Relationship,Custom Individual ID,Employee Noyo ID,Noyo Member ID,First Name,Middle Name,Last Name,Date of Birth,SSN,Sex,Home Address Street 1,Home Address Street 2,Home Address City,Home Address State,Home Address ZIP Code,Home Address County,Hire Date,Full Time Start,Hours Worked,Job Title,Email,Home Phone Number,Employment Status,Line of Coverage,Carrier ID,Carrier Name,Noyo Plan ID,Plan Type,Carrier Plan Name,Effective Start Date,Effective End Date,Enrollment Status,COBRA Enrolled,Department Number,Division Number,Class Number,System ID,Cert Number,Claimant Number,Coverage Code" } }, "description": "Successful Response - Returns file contents" } }, "summary": "Get file associated with group coverage export", "tags": [ "Group Coverage Export" ] } }, "/api/v1/group_disconnection_requests": { "get": { "description": "Returns a list of all group Disconnection requests.", "operationId": "getGroupDisconnectionRequestList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "Status of the group Disconnection requests for which you would like to filter.", "in": "query", "name": "status", "schema": { "example": "created", "type": "string" } }, { "description": "Search by group name", "in": "query", "name": "search", "required": false, "schema": { "example": "Widgets R Us", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "effective_end_date": "2025-01-01", "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Widgets R Us", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_id": null, "source_type": "platform", "status": "processing", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupDisconnectionRequestResult" } } }, "description": "Successful Response - Returns all matching Group Disconnection Requests" } }, "summary": "List Group Disconnection Requests", "tags": [ "Group Connections" ] }, "post": { "description": "Create a new Group Disconnection Request", "operationId": "createNewGroupDisconnectionRequest", "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "effective_end_date": "2025-01-01", "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922" } } }, "schema": { "$ref": "#/components/schemas/GroupDisconnectionRequestPublicCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "effective_end_date": "2025-01-01", "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Besta LLC", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_id": null, "source_type": "platform", "status": "processing", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" }, "schema": { "$ref": "#/components/schemas/GroupDisconnectionRequestResult" } } }, "description": "Successful Response - Returns the new GroupDisconnectionRequest" } }, "summary": "Create a new Group Disconnection Request", "tags": [ "GroupDisconnectionRequest" ] } }, "/api/v1/group_disconnection_requests/{group_disconnection_request_id}": { "get": { "description": "Returns a group offboading request by ID.", "operationId": "getGroupDisconnectionRequestById", "parameters": [ { "description": "The unique identifier of the group disconnection request you want to retrieve", "in": "path", "name": "group_disconnection_request_id", "required": true, "schema": { "example": "4093a441-d4c8-4c8a-24d1-e7a132fb1bc2", "format": "uuid", "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "example": { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "effective_end_date": "2025-01-01", "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Besta LLC", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_id": null, "source_type": "platform", "status": "processing", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" }, "schema": { "$ref": "#/components/schemas/GroupDisconnectionRequestResult" } } }, "description": "Successful Response - Returns the GroupDisconnectionRequest" } }, "summary": "Get an existing group offboading request by id", "tags": [ "GroupDisconnectionRequest" ] }, "x-summary": "Get Group disconnection Request by request Id" }, "/api/v1/group_disconnection_requests/{group_disconnection_request_id}/confirm": { "put": { "description": "Confirm Group Disconnection", "operationId": "confirmGroupDisconnectionRequest", "parameters": [ { "description": "The unique identifier of the group disconnection request you want to confirm", "in": "path", "name": "group_disconnection_request_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "effective_end_date": "2024-01-01" } } }, "schema": { "$ref": "#/components/schemas/GroupDisconnectionRequestPublicConfirmRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "example": { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Widgets R Us", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_type": "carrier", "status": "processing", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" }, "schema": { "$ref": "#/components/schemas/GroupDisconnectionRequestResult" } } }, "description": "Successful Response - Returns the confirmed GroupDisconnectionRequest" } }, "summary": "Confirm Group Disconnection", "tags": [ "GroupDisconnectionRequest" ] }, "x-summary": "Confirm group disconnection request by id" }, "/api/v1/group_disconnection_requests/{group_disconnection_request_id}/reject": { "put": { "description": "Reject Group Disconnection", "operationId": "rejectGroupDisconnectionRequest", "parameters": [ { "description": "The unique identifier of the group disconnection request you want to reject", "in": "path", "name": "group_disconnection_request_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Widgets R Us", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_type": "carrier", "status": "rejected", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" }, "schema": { "$ref": "#/components/schemas/GroupDisconnectionRequestResult" } } }, "description": "Successful Response - Returns the rejected GroupDisconnectionRequest" } }, "summary": "Reject Group Disconnection", "tags": [ "GroupDisconnectionRequest" ] }, "x-summary": "Reject group disconnection request by id" }, "/api/v1/group_disconnection_requests/{group_disconnection_request_id}/{version}": { "put": { "description": "Edit a Group Disconnection Request", "operationId": "editGroupDisconnectionRequest", "parameters": [ { "description": "The unique identifier of the group disconnection request you want to update", "in": "path", "name": "group_disconnection_request_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The unique version of the group disconnection request you want to edit.", "in": "path", "name": "version", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "effective_end_date": "2025-01-01", "status": "processing" } } }, "schema": { "$ref": "#/components/schemas/GroupDisconnectionRequestPublicEditRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Widgets R Us", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_id": null, "source_type": "platform", "status": "processing", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" }, "schema": { "$ref": "#/components/schemas/GroupDisconnectionRequestResult" } } }, "description": "Successful Response - Returns the new GroupDisconnectionRequest" } }, "summary": "Edit an existing Group Disconnection Request", "tags": [ "GroupDisconnectionRequest" ] }, "x-summary": "Edit group disconnection request by id" }, "/api/v1/group_enrollments/{enrollment_id}": { "get": { "description": "Returns the latest version of a single group enrollment based on the ID provided.", "operationId": "getGroupEnrollment", "parameters": [ { "description": "Unique identifier of the group enrollment", "in": "path", "name": "enrollment_id", "required": true, "schema": { "example": "7499ea07-76c9-40f2-992b-952259e98384", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "created": 1557512389, "effective_end_date": "2019-12-31", "effective_start_date": "2019-01-01", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "7499ea07-76c9-40f2-992b-952259e98384", "line_of_coverage": "medical", "modified": 1543215342, "open_enrollment_end_date": "2019-02-01", "open_enrollment_start_date": "2019-01-01", "status": "active", "version": "c2292b67-0382-45e9-a378-b52c4129f672" }, "schema": { "$ref": "#/components/schemas/GroupEnrollmentPublicResult" } } }, "description": "Successful Response - Returns a single Group Enrollment" } }, "summary": "Get a single Group Enrollment", "tags": [ "Group Plans & Enrollment" ] }, "x-summary": "Get Group Enrollment" }, "/api/v1/group_enrollments/{enrollment_id}/plans": { "get": { "description": "Returns a list of all plans for a given group enrollment.", "operationId": "getGroupEnrollmentPlanList", "parameters": [ { "description": "The unique identifier of the group enrollment for which you would like to view the plans", "in": "path", "name": "enrollment_id", "required": true, "schema": { "example": "31559b4b-e45a-4df8-84f6-2220d7ed0c3a", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16", "cobra_rules": { "eligible": false }, "code": "D1", "created": 1554175253, "effective_end_date": "9999-12-31", "effective_start_date": "2020-01-01", "eligible_member_types": [ "employee" ], "group_enrollment_id": "31559b4b-e45a-4df8-84f6-2220d7ed0c3a", "id": "5ba915fc-afe8-4572-a60f-61ee5883e100", "line_of_coverage": "dental", "modified": 1554175253, "name": "Dental", "network": "Dental PPO Network", "plan_type": "ppo", "status": "active", "termination_policy": "last_work_date", "version": "1bf06a82-8d81-4849-91d3-47c60fdce605", "voluntary": false, "waiting_periods": [] }, { "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16", "cobra_rules": { "eligible": false }, "code": "D1", "created": 1554175253, "effective_end_date": "9999-12-31", "effective_start_date": "2020-01-01", "eligible_member_types": [ "spouse", "child" ], "group_enrollment_id": "31559b4b-e45a-4df8-84f6-2220d7ed0c3a", "id": "c1279c1c-ed61-439b-bd9c-07f3228c09cb", "line_of_coverage": "dental", "modified": 1554175253, "name": "Dental", "network": "Dental PPO Network", "plan_type": "ppo", "status": "active", "termination_policy": "last_work_date", "version": "a6404fb2-f266-45b0-a6b7-84b047f017cf", "voluntary": false, "waiting_periods": [] } ], "schema": { "items": { "$ref": "#/components/schemas/GroupDentalPlanPublicResult" }, "type": "array" } } }, "description": "Successful Response - Returns all matching Plans" } }, "summary": "Get a list of all Group Enrollment Plans", "tags": [ "Group Plans & Enrollment" ] }, "x-summary": "List Group Enrollment Plans" }, "/api/v1/group_enrollments/{group_enrollment_id}/individual_enrollments": { "get": { "description": "Returns a list of all individual enrollments for a given group enrollment.", "operationId": "getIndividualEnrollmentList", "parameters": [ { "description": "Unique identifier of the associated group enrollment in the Noyo system", "in": "path", "name": "group_enrollment_id", "required": true, "schema": { "example": "bf129409-1f0a-4f1a-b756-14471ef733c3", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "cobra_enrollment": { "cobra_enrolled": true, "cobra_type": "federal" }, "created": 1557512389, "effective_end_date": "2019-12-31", "effective_start_date": "2019-01-01", "enroll_data": { "premium": { "amount": 50, "unit": "Month" } }, "group_enrollment_id": "bf129409-1f0a-4f1a-b756-14471ef733c3", "id": "6670f290-4236-4690-bece-a110f9ad924b", "individual_enrollment_configuration": {}, "individual_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "individual_type": "employee", "line_of_coverage": "medical", "modified": 1564440756, "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a", "status": "active", "version": "27bbf929-78ca-4339-8bb3-39b75f92c4a4" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedIndividualEnrollmentResult" } } }, "description": "Successful Response - Returns all matching Individual Enrollments" } }, "summary": "Get a list of all Individual Enrollments By Group Enrollment", "tags": [ "Individual Enrollments" ] }, "x-summary": "Get All Individual Enrollments By Group Enrollment" }, "/api/v1/groups": { "get": { "description": "Returns a list of all groups in the current user organization.\n\nIf you would like to search the groups list, you can use the company query param. It allows searches based on the group's name or dba_name values.\n", "operationId": "getGroupList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "This query param searches groups by name or dba_name values", "in": "query", "name": "company", "required": false, "schema": { "type": "string" } }, { "description": "Comma-separated list of requested UUID group IDs", "in": "query", "name": "group_ids", "required": false, "schema": { "type": "string" } }, { "description": "Used for filtering for a carrier-specific group ID. Filter by the Noyo carrier ID. Must be used with carrier_group_id", "in": "query", "name": "carrier_id", "required": false, "schema": { "type": "string" } }, { "description": "Used for filtering for a carrier-specific group ID. Must be used with carrier_id", "in": "query", "name": "carrier_group_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "created": 1557512389, "dba_name": "Test Corp", "federal_ein": "112222222", "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "modified": 1543215342, "name": "Test Company", "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "sic_code": "7371", "version": "6b72d72d-cc99-4df6-8152-7183e824c80c" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupResult" } } }, "description": "Successful Response - Returns all matching Groups" } }, "summary": "Get a list of all Groups", "tags": [ "Group Configuration" ] }, "x-summary": "Get Groups" }, "/api/v1/groups/{group_id}": { "get": { "description": "Returns the latest version of a single group based on the ID provided.", "operationId": "getGroup", "parameters": [ { "description": "The unique identifier of the group to be retrieved", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created": 1557512389, "dba_name": "Test Corp", "federal_ein": "112222222", "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "modified": 1543215342, "name": "Test Company", "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "sic_code": "7371", "version": "6b72d72d-cc99-4df6-8152-7183e824c80c" }, "schema": { "$ref": "#/components/schemas/GroupResult" } } }, "description": "Successful Response - Returns a single Group" } }, "summary": "Get a single Group", "tags": [ "Group Configuration" ] }, "x-summary": "Get Single Group" }, "/api/v1/groups/{group_id}/audit_requests/latest": { "get": { "description": "Noyo regularly audits each Group against the carrier(s) that the Group has coverage with in order to find updated data and potential mismatches. This endpoint returns metadata about the latest group audit request that was completed. If no group audits have been completed the `completed_at` timestamp will be the timestamp of when the group was created and the `carrier_ids` array will be empty.", "operationId": "getLatestGroupAuditRequest", "parameters": [ { "description": "The unique identifier of the associated group in Noyo", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2ce3b54a-2535-4803-b218-e6b44081d418", "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the carrier for which you would like to view audit requests", "in": "query", "name": "carrier_id", "required": false, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "carrier_ids": [ "8fac0992-933a-4743-8dab-0d606ef2569e" ], "completed_at": 1602609543, "group_id": "2ce3b54a-2535-4803-b218-e6b44081d418" }, "schema": { "$ref": "#/components/schemas/LatestGroupAuditRequestResult" } } }, "description": "Successful Response - Returns metadata about the latest Group Audit Request" } }, "summary": "Get Latest Group Audit Request", "tags": [ "Carrier Sync" ] } }, "/api/v1/groups/{group_id}/audit_requests/list_latest": { "get": { "description": "Noyo regularly audits each Group against the carrier(s) that the Group has coverage with in order to find updated data and potential mismatches. This endpoint returns metadata about the latest group audit requests that were completed for each carrier. If no group audits have been completed the `completed_at` timestamp will be the timestamp of when the group was created and the `carrier_ids` array will be empty.", "operationId": "getLatestGroupAuditRequestList", "parameters": [ { "description": "The unique identifier of the associated group in Noyo", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2ce3b54a-2535-4803-b218-e6b44081d418", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "carrier_ids": [ "8fac0992-933a-4743-8dab-0d606ef2569e" ], "completed_at": 1602609543, "group_id": "2ce3b54a-2535-4803-b218-e6b44081d418" } ], "schema": { "items": { "$ref": "#/components/schemas/LatestGroupAuditRequestResult" }, "type": "array" } } }, "description": "Successful Response - Returns metadata list about the latest Group Audit Requests for each carrier in the group's carrier config" } }, "summary": "Get Latest Group Audit Request List", "tags": [ "Carrier Sync" ] } }, "/api/v1/groups/{group_id}/carrier_configurations": { "get": { "description": "Certain carriers have custom data for each group such as billing group information. This endpoint can be used to retrieve carrier-specific configuration data.", "operationId": "getCarrierConfigurationByGroupList", "parameters": [ { "description": "The unique identifier of the group for which you would like to view carrier configurations.", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2705bb9f-3c90-4400-a4e7-0bc9d48e677c", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": [ { "carrier_group_id": "9100084", "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16", "configuration": { "bill_groups": [ { "bill_group_description": "All Members", "bill_group_number": 10001, "bill_group_status": "open" } ], "member_groups": [ { "member_group_key": 2613038, "member_group_name": "MEMBERS A", "member_group_status": "open" }, { "member_group_key": 2613037, "member_group_name": "MEMBERS B", "member_group_status": "open" } ], "policy_number": "9100084" }, "group_id": "2705bb9f-3c90-4400-a4e7-0bc9d48e677c" } ], "schema": { "items": { "$ref": "#/components/schemas/PublicGroupCarrierConfigurationResult" }, "type": "array" } } }, "description": "Successful Response - Returns all matching Carrier Configurations" } }, "summary": "Get a list of all Carrier Configurations by Group", "tags": [ "Group Configuration" ] }, "x-summary": "Get Group Carrier Configurations" }, "/api/v1/groups/{group_id}/contacts": { "get": { "description": "Returns a list of all group contacts for a given group.", "operationId": "getContactList", "parameters": [ { "description": "The unique identifier of the group for which you would like to view contacts", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "created": 1557512389, "email": "davidsmith@testcorp.com", "first_name": "David", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "c2f5489d-36d1-4fb0-bf9f-105ad5dd0b3e", "last_name": "Smith", "modified": 1543215342, "phone_number": "+14255551234", "primary_contact": true, "title": "Chief People Officer", "types": [ "company", "billing" ], "version": "6ba43c6e-69f2-435f-a126-8595a798eb52" }, { "created": 1557512389, "email": "carolinejohnson@testcorp.com", "first_name": "Caroline", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "7e3c1f14-e7e7-42b8-81d8-3fcd7bd7d418", "last_name": "Johnson", "modified": 1543215342, "phone_number": "+14255551234", "primary_contact": false, "title": "VP of Human Resources", "types": [ "executive" ], "version": "88bfbe28-7f8b-4497-a50b-932ee3387b68" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedContactResult" } } }, "description": "Successful Response - Returns all matching Group Contacts" } }, "summary": "Get a list of all Group Contacts", "tags": [ "Group Configuration" ] }, "x-summary": "Contacts" }, "/api/v1/groups/{group_id}/contacts/{contact_id}": { "get": { "description": "Returns the latest version of a single group contact based on the ID provided.", "operationId": "getContact", "parameters": [ { "description": "The unique identifier of the group the contact belongs to", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the contact to be retrieved", "in": "path", "name": "contact_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created": 1557512389, "email": "davidsmith@testcorp.com", "first_name": "David", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "c2f5489d-36d1-4fb0-bf9f-105ad5dd0b3e", "last_name": "Smith", "modified": 1543215342, "phone_number": "+14255551234", "primary_contact": true, "title": "Chief People Officer", "types": [ "company", "billing", "executive" ], "version": "ef3fef8d-4889-40f4-a0f8-377b9dd23d98" }, "schema": { "$ref": "#/components/schemas/ContactResult" } } }, "description": "Successful Response - Returns a single Group Contact" } }, "summary": "Get a single Group Contact", "tags": [ "Group Configuration" ] }, "x-summary": "Get Single Contact" }, "/api/v1/groups/{group_id}/coverage_exports": { "get": { "description": "Returns a list of group coverage exports based on the Group ID provided.", "operationId": "getGroupCoverageExportsForGroup", "parameters": [ { "description": "The unique identifier of the group you would like to get group exports for", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "as_of": "2023-01-31", "carrier_ids": [ "8fac0992-933a-4743-8dab-0d606ef2569e" ], "completed": null, "created": 1675199964, "expires": null, "file_format": "csv", "file_key": "csv-uploads/2613a221-d3c8-4c8a-86d5-e7e885fd1da9/2023-02-01-test-group-coverage-export.xlsx", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "0620e171-5dcc-4f2b-9143-6c96a5ee9925", "modified": 1675199964, "percentage_complete": 0, "request_user_id": "00112806-bd97-442d-8884-83e71c3de057", "status": "processing", "version": "f5133f0a-30ae-443a-80f0-9975abec3213" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupCoverageExportResult" } } }, "description": "Successful Response - Returns Group Coverage Exports" } }, "summary": "Get Group Coverage Exports for a Group", "tags": [ "Group Coverage Export" ] }, "post": { "description": "Request a new Group Coverage Export for a group.", "operationId": "createGroupCoverageExport", "parameters": [ { "description": "The unique identifier of the group to create a Group Coverage Export for.", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "as_of": "2023-01-31", "carrier_ids": [ "8fac0992-933a-4743-8dab-0d606ef2569e" ] } } }, "schema": { "$ref": "#/components/schemas/GroupCoverageExportCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "as_of": "2023-01-31", "carrier_ids": [ "8fac0992-933a-4743-8dab-0d606ef2569e" ], "created": 1675113819, "file_format": "csv", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "0620e171-5dcc-4f2b-9143-6c96a5ee9925", "modified": 1675113819, "percentage_complete": 0, "request_user_id": "00112806-bd97-442d-8884-83e71c3de057", "status": "processing", "version": "e3fa3878-e5ec-449f-975a-1c2dadf4ae87" }, "schema": { "$ref": "#/components/schemas/GroupCoverageExportResult" } } }, "description": "Successful Response - Returns the contents of the newly requested Group Coverage Export" } }, "summary": "Create a Group Coverage Export", "tags": [ "Group Coverage Export" ] }, "x-summary": "Public endpoint for creating a group coverage export" }, "/api/v1/groups/{group_id}/dependents/{dependent_id}": { "get": { "description": "Returns the latest version of a single dependent based on the Group and ID provided.", "operationId": "getGroupDependent", "parameters": [ { "description": "The unique identifier of the group which the dependent you would like to query belows to", "in": "path", "name": "group_id", "required": true, "schema": { "example": "fd62665c-0846-4e9d-bd29-80779b5f685c", "format": "uuid", "type": "string" } }, { "description": "Either the Noyo ID or the Custom Individual ID of the dependent you would like to query", "in": "path", "name": "dependent_id", "required": true, "schema": { "example": "FD1324345", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created": 1557512389, "custom_individual_id": "FD1324345", "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "modified": 1547412389, "person": { "contact": { "email_address": "diane@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1982-01-02", "first_name": "Diane", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "sex": "F", "ssn": "987654321" }, "relationship": "spouse", "version": "669fbe16-9960-4069-91aa-832ada3f4e42" }, "schema": { "$ref": "#/components/schemas/DependentResult" } } }, "description": "Successful Response - Returns a single Dependent" } }, "summary": "Get a single Dependent by Group", "tags": [ "Dependent" ] } }, "/api/v1/groups/{group_id}/employees": { "get": { "description": "Returns a list of all employees for a given group.", "operationId": "getGroupEmployeeList", "parameters": [ { "description": "The unique identifier of the group for which you would like to view employees", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "The employee first name for which you would like to filter", "in": "query", "name": "first_name", "required": false, "schema": { "type": "string" } }, { "description": "The employee last name for which you would like to filter", "in": "query", "name": "last_name", "required": false, "schema": { "type": "string" } }, { "description": "The employee's name for which you would like to filter", "in": "query", "name": "name", "required": false, "schema": { "type": "string" } }, { "description": "The ISO-8601 (YYYY-MM-DD) employee date of birth for which you would like to filter", "in": "query", "name": "date_of_birth", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "type": "salary", "unit": "annual" } }, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1981-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "", "sex": "M", "ssn": "123456789" }, "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedEmployeeResult" } } }, "description": "Successful Response - Returns all matching Employees" } }, "summary": "Get a list of all Employees", "tags": [ "Group Configuration" ] }, "x-summary": "Get Employees in a Group" }, "/api/v1/groups/{group_id}/employees/{employee_id}": { "get": { "description": "Returns the latest version of a single employee based on the Noyo ID or Custom Individual ID provided.", "operationId": "getGroupEmployee", "parameters": [ { "description": "The Noyo ID or Custom Individual ID of the employee you would like to view", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "D123456789", "type": "string" } }, { "description": "The Noyo ID of the Group the employee belongs to.", "in": "path", "name": "group_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "custom_individual_id": "12FEXC13431", "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "type": "salary", "unit": "annual" }, "work_state": "CA" }, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "location_id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1981-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "", "sex": "M", "ssn": "123456789" }, "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" }, "schema": { "$ref": "#/components/schemas/EmployeeResult" } } }, "description": "Successful Response - Returns a single Employee" } }, "summary": "Get a single Employee within a Group", "tags": [ "Employee" ] }, "x-summary": "Get Employee Within a Group By Either Noyo or Custom Individual ID" }, "/api/v1/groups/{group_id}/employees/{employee_id}/dependents": { "get": { "description": "Returns a list of all dependents for a given employee and group.", "operationId": "getGroupEmployeeDependentList", "parameters": [ { "description": "The unique identifier of the group for which you would like to view dependents", "in": "path", "name": "group_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } }, { "description": "Either the Noyo ID or the Custom Individual ID of the employee for which you would like to view dependents", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "PD713414312", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "created": 1557512389, "custom_individual_id": "FD1324345", "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "modified": 1547412389, "person": { "contact": { "email_address": "diane@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1982-01-02", "first_name": "Diane", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "", "sex": "F", "ssn": "987654321" }, "relationship": "spouse", "version": "669fbe16-9960-4069-91aa-832ada3f4e42" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedDependentResult" } } }, "description": "Successful Response - Returns all matching Dependents" } }, "summary": "List All Group Employee Dependents", "tags": [ "Group Configuration" ] }, "x-summary": "Get Dependent Within a Group By Either Noyo or Custom Individual ID" }, "/api/v1/groups/{group_id}/employees/{employee_id}/dependents/{dependent_id}": { "get": { "description": "Returns the latest version of a single dependent based on the Group, Employee and ID provided.", "operationId": "getGroupEmployeeDependent", "parameters": [ { "description": "The unique identifier of the group which the dependent you would like to query belows to", "in": "path", "name": "group_id", "required": true, "schema": { "example": "fd62665c-0846-4e9d-bd29-80779b5f685c", "format": "uuid", "type": "string" } }, { "description": "Either the Noyo ID or the Custom Individual ID of the employee which the dependent you would like to query belows to", "in": "path", "name": "employee_id", "required": true, "schema": { "example": "PD713414312", "type": "string" } }, { "description": "Either the Noyo ID or the Custom Individual ID of the dependent you would like to query", "in": "path", "name": "dependent_id", "required": true, "schema": { "example": "FD1324345", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created": 1557512389, "custom_individual_id": "FD1324345", "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "fd62665c-0846-4e9d-bd29-80779b5f685c", "modified": 1547412389, "person": { "contact": { "email_address": "diane@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1982-01-02", "first_name": "Diane", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "sex": "F", "ssn": "987654321" }, "relationship": "spouse", "version": "669fbe16-9960-4069-91aa-832ada3f4e42" }, "schema": { "$ref": "#/components/schemas/DependentResult" } } }, "description": "Successful Response - Returns a single Dependent" } }, "summary": "Get a single Dependent by Group and Employee ID", "tags": [ "Dependent" ] }, "x-summary": "Get Dependent Within a Group's Employee By Either Noyo or Custom Individual ID" }, "/api/v1/groups/{group_id}/group_connections": { "get": { "description": "Returns a list of all group connections for a given group ID.", "operationId": "getGroupConnectionRequestListByGroup", "parameters": [ { "description": "The unique identifier of the associated group in Noyo", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2ce3b54a-2535-4803-b218-e6b44081d418", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "The attribute on which to sort the group connections", "in": "query", "name": "sort_by", "required": false, "schema": { "type": "string" } }, { "description": "Either asc or desc, to denote the data's direction", "in": "query", "name": "sort_direction", "required": false, "schema": { "type": "string" } }, { "description": "Status of group connection for which you would like to filter. Multiple statuses can be used, separated by a comma.", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "completed": 1557392400, "created": 1557329939, "group_data": { "carrier_group_id": "10000000", "group_name": "Test Company" }, "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557392400, "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "request_type": "initial", "status": "processing", "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupSetupRequestPublicResult" } } }, "description": "Successful Response - Returns all matching Group Connection Requests" } }, "summary": "List Group Connections by Group", "tags": [ "Group Connections" ] }, "post": { "description": "Create a new carrier connection for an existing group", "operationId": "createGroupConnectionWithExistingGroup", "parameters": [ { "description": "The unique identifier of the group for which you would like to add a carrier connection", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "group_data": { "carrier_group_id": "10000000" } } } }, "schema": { "$ref": "#/components/schemas/GroupSetupRequestPublicAPINestedCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "created": 1557329939, "group_data": { "carrier_group_id": "10000000" }, "group_id": "47c07963-2e34-4da2-86b4-cbc3c57111c1", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "request_type": "incremental", "status": "created", "version": "9906b5d2-e76d-4bad-ba4c-8ce90b6b867b" }, "schema": { "$ref": "#/components/schemas/GroupSetupRequestResult" } } }, "description": "Successful Response - Returns the new Group Connection" } }, "summary": "Create a new group connection in an existing group", "tags": [ "Group Connections" ] } }, "/api/v1/groups/{group_id}/group_disconnection_requests": { "get": { "description": "Returns a list of all group Disconnection requests for a given group Id.", "operationId": "getGroupDisconnectionRequestListByGroup", "parameters": [ { "description": "The unique identifier of the associated group in Noyo", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2ce3b54a-2535-4803-b218-e6b44081d418", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "effective_end_date": "2025-01-01", "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Widgets R Us", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_id": null, "source_type": "platform", "status": "processing", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupDisconnectionRequestResult" } } }, "description": "Successful Response - Returns all matching Group Disconnection Requests" } }, "summary": "List Group Disconnection Request by Group", "tags": [ "GroupDisconnectionRequest" ] }, "x-summary": "Group disconnection requests by group" }, "/api/v1/groups/{group_id}/group_enrollments": { "get": { "description": "Returns a list of all group enrollments for a given group.", "operationId": "getGroupEnrollmentList", "parameters": [ { "description": "The unique identifier of the group for which you would like to view group enrollments", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } }, { "description": "The status of the group enrollments you would like to view", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "created": 1557512389, "effective_end_date": "2019-12-31", "effective_start_date": "2019-01-01", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "7499ea07-76c9-40f2-992b-952259e98384", "line_of_coverage": "medical", "modified": 1543215342, "open_enrollment_end_date": "2019-02-01", "open_enrollment_start_date": "2019-01-01", "status": "active", "version": "c2292b67-0382-45e9-a378-b52c4129f672" }, { "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "created": 1557512389, "effective_end_date": "2019-12-31", "effective_start_date": "2019-01-01", "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "25cdcb18-7d01-4599-9f65-d38b36d7c370", "line_of_coverage": "dental", "modified": 1543215342, "open_enrollment_end_date": "2019-02-01", "open_enrollment_start_date": "2019-01-01", "status": "active", "version": "55c4bcbb-98ab-448d-a5b4-d7d835327f72" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupEnrollmentResult" } } }, "description": "Successful Response - Returns all matching Group Enrollments" } }, "summary": "Get a list of all Group Enrollments", "tags": [ "Group Plans & Enrollment" ] }, "x-summary": "Get All Group Enrollments" }, "/api/v1/groups/{group_id}/individual_enrollments": { "get": { "description": "Returns a list of all individual enrollments for a given group.", "operationId": "getIndividualEnrollmentByGroupList", "parameters": [ { "description": "Unique identifier of the associated group in the Noyo system", "in": "path", "name": "group_id", "required": true, "schema": { "example": "f8de4493-3c51-4337-8fdc-f00bb1ae89bd", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "cobra_enrollment": { "cobra_enrolled": true, "cobra_type": "federal" }, "created": 1557512389, "effective_end_date": "2019-12-31", "effective_start_date": "2019-01-01", "enroll_data": { "premium": { "amount": 50, "unit": "Month" } }, "group_enrollment_id": "7499ea07-76c9-40f2-992b-952259e98384", "id": "6670f290-4236-4690-bece-a110f9ad924b", "individual_enrollment_configuration": {}, "individual_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "individual_type": "employee", "line_of_coverage": "medical", "modified": 1564440756, "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a", "status": "active", "version": "27bbf929-78ca-4339-8bb3-39b75f92c4a4" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedIndividualEnrollmentResult" } } }, "description": "Successful Response - Returns all matching Individual Enrollments" } }, "summary": "Get a list of all Individual Enrollments By Group", "tags": [ "Individual Enrollments" ] }, "x-summary": "Get All Individual Enrollments By Group" }, "/api/v1/groups/{group_id}/locations": { "get": { "description": "Returns a list of all group locations for a given group.", "operationId": "getLocationList", "parameters": [ { "description": "The unique identifier of the group for which you would like to view locations", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Test Ln", "zip_code": "94107" }, "created": 1557512389, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "modified": 1543215342, "version": "f4142cba-f3eb-4917-b3bd-123d683f18d7" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedLocationResult" } } }, "description": "Successful Response - Returns all matching Group Locations" } }, "summary": "Get a list of all Group Location", "tags": [ "Group Configuration" ] }, "x-summary": "Get All Locations" }, "/api/v1/groups/{group_id}/locations/{location_id}": { "get": { "description": "Returns the latest version of a single group location based on the ID provided.", "operationId": "getLocation", "parameters": [ { "description": "The unique identifier of the group the location belongs to", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the location to be retrieved", "in": "path", "name": "location_id", "required": true, "schema": { "example": "bd957820-4652-4ee7-8a3a-6413df21e28d", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Test Ln", "zip_code": "94107" }, "created": 1557512389, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "modified": 1543215342, "version": "f4142cba-f3eb-4917-b3bd-123d683f18d7" }, "schema": { "$ref": "#/components/schemas/LocationResult" } } }, "description": "Successful Response - Returns a single Group Location" } }, "summary": "Get a single Group Location", "tags": [ "Group Configuration" ] }, "x-summary": "Get Single Location" }, "/api/v1/groups/{group_id}/member_snapshots": { "get": { "description": "Returns a list with metadata for all member snapshots for a given group.", "operationId": "getMemberSnapshotsForGroupList", "parameters": [ { "description": "The unique identifier of the group for which you would like to view member snapshots", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "The employee ID associated with the member snapshot", "in": "query", "name": "employee_id", "required": false, "schema": { "example": "a88f4b6f-7c26-4dd0-8b62-6c76f06412ad", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "created": 1599184829, "employee_id": "7f39b5e0-460d-49e2-83b7-a1b6f2726b12", "id": "bc4aea3e-f728-4b05-85dc-e1ea14456e83", "modified": 1599184829, "status": "processing", "version": "431b7d10-3da6-4c5e-bb2f-58a6ebb1224f" }, { "created": 1557512389, "employee_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "modified": 1564440756, "status": "completed", "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedMemberSnapshotResult" } } }, "description": "Successful Response - Returns metadata for any matching Member Snapshots" } }, "summary": "Get all Member Snapshots by Group", "tags": [ "Member Snapshot" ] }, "post": { "description": "Create a new Member Snapshot for an employee associated with a group.", "operationId": "createMemberSnapshot", "parameters": [ { "description": "The unique identifier of the group for the employee referenced in the snapshot", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "coverages": [ { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "individual_type": "employee", "latest_change_effective_date": "2022-02-13" }, { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "9da3ea58-73fc-4a99-82c3-489bb4a4c1d4", "individual_type": "dependent" } ], "line_of_coverage": "medical", "plan_id": "4bf04f73-0aad-48ac-b28a-e5f4def7c5e9", "signature_date": "2021-12-23" }, { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "cobra_enrolled": true, "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "individual_type": "employee" }, { "effective_end_date": "2021-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "9da3ea58-73fc-4a99-82c3-489bb4a4c1d4", "individual_type": "dependent" } ], "line_of_coverage": "dental", "plan_name": "DHMO Smile Plus", "signature_date": "2021-12-23" }, { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "individual_type": "employee", "volume": 50000 } ], "line_of_coverage": "life", "plan_name": "50k Employee Basic Life", "signature_date": "2021-12-23" } ], "dependents": [ { "event_id": "1", "id": "ab740704-7c37-4010-92b3-d22c6926be3e", "person": { "contact": { "email_address": "jamie@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1990-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": "married", "sex": "F", "ssn": "987654321" }, "relationship": "spouse" } ], "employee": { "classifications": { "BranchName": "HQ", "Department": "Sales" }, "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "effective_date": "2022-01-31", "type": "salary", "unit": "annual" } }, "event_id": "1", "id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1985-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "middle_name": "A", "sex": "M", "ssn": "123456789", "suffix": "Jr" } }, "events": [ { "date": "2022-01-01", "id": "1", "reason": "open_enrollment", "type": "coverage" } ], "snapshot_mode": "current_open" } } }, "schema": { "$ref": "#/components/schemas/MemberSnapshotWeb" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "created": 1656030390, "employee_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "id": "7bea80ac-499d-560b-5512-60be9e2349cb", "member_snapshot": { "coverages": [ { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "individual_type": "employee", "latest_change_effective_date": "2022-02-13" }, { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "9da3ea58-73fc-4a99-82c3-489bb4a4c1d4", "individual_type": "dependent" } ], "line_of_coverage": "medical", "plan_id": "4bf04f73-0aad-48ac-b28a-e5f4def7c5e9", "signature_date": "2021-12-23" }, { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_type": "employee" }, { "effective_end_date": "2021-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "9da3ea58-73fc-4a99-82c3-489bb4a4c1d4", "individual_type": "dependent" } ], "line_of_coverage": "dental", "plan_name": "DHMO Smile Plus", "signature_date": "2021-12-23" }, { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_type": "employee", "volume": 50000 } ], "line_of_coverage": "life", "plan_name": "50k Employee Basic Life", "signature_date": "2021-12-23" } ], "dependents": [ { "event_id": "1", "id": "ab740704-7c37-4010-92b3-d22c6926be3e", "person": { "contact": { "email_address": "jamie@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1990-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": "married", "sex": "F", "ssn": "987654321" }, "relationship": "spouse" } ], "employee": { "classifications": { "BranchName": "HQ", "Department": "Sales" }, "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "effective_date": "2022-01-31", "type": "salary", "unit": "annual" } }, "event_id": "1", "group_id": "d0ec3837-3499-4a2f-8c58-966ef7e46d95", "id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1985-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "middle_name": "A", "sex": "M", "ssn": "123456789", "suffix": "Jr" } }, "events": [ { "date": "2022-01-01", "id": "1", "reason": "open_enrollment", "type": "enrollment" } ], "snapshot_mode": "current_open" }, "modified": 1656030390, "status": "processing", "version": "271c60d6-f009-4b3d-8bba-aac49b2dd9a4" }, "schema": { "$ref": "#/components/schemas/MemberSnapshotResult" } } }, "description": "Successful Response - Returns the contents of the newly created Member Snapshot" } }, "summary": "Create a Member Snapshot", "tags": [ "Member Snapshot" ] }, "x-summary": "Get all member snapshots by group" }, "/api/v1/groups/{group_id}/plans": { "get": { "description": "Returns a list of all plans for a given group.", "operationId": "getGroupPlanList", "parameters": [ { "description": "The unique identifier of the group for which you would like to view plans", "in": "path", "name": "group_id", "required": true, "schema": { "example": "31559b4b-e45a-4df8-84f6-2220d7ed0c3a", "format": "uuid", "type": "string" } }, { "description": "Status of the group plans for which you would like to filter", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "Line of coverage of the group plans for which you would like to filter", "in": "query", "name": "line_of_coverage", "required": false, "schema": { "type": "string" } }, { "description": "The unique identifier of the carrier of the group plans for which you would like to filter", "in": "query", "name": "carrier_id", "required": false, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "cobra_rules": { "eligible": false }, "code": "D1", "created": 1554175253, "effective_end_date": "9999-12-31", "effective_start_date": "2020-01-01", "eligible_member_types": [ "employee" ], "group_enrollment_id": "31559b4b-e45a-4df8-84f6-2220d7ed0c3a", "id": "5ba915fc-afe8-4572-a60f-61ee5883e100", "line_of_coverage": "dental", "modified": 1554175253, "name": "Dental - Employee", "network": "Dental PPO Network", "plan_type": "ppo", "status": "active", "termination_policy": "end_of_month", "version": "1bf06a82-8d81-4849-91d3-47c60fdce605", "voluntary": false, "waiting_periods": [ { "waiting_period_enrollment_type": "new_member", "waiting_period_rule": "hire_date" }, { "waiting_period_amount": 0, "waiting_period_enrollment_type": "current_member", "waiting_period_rule": "after_waiting_period", "waiting_period_unit": "day" } ] }, { "cobra_rules": { "eligible": false }, "code": "D1", "created": 1554175253, "effective_end_date": "9999-12-31", "effective_start_date": "2020-01-01", "eligible_member_types": [ "spouse", "child" ], "group_enrollment_id": "31559b4b-e45a-4df8-84f6-2220d7ed0c3a", "id": "c1279c1c-ed61-439b-bd9c-07f3228c09cb", "line_of_coverage": "dental", "modified": 1554175253, "name": "Dental - Dependent", "network": "Dental PPO Network", "plan_type": "ppo", "status": "active", "termination_policy": "end_of_month", "version": "a6404fb2-f266-45b0-a6b7-84b047f017cf", "voluntary": false, "waiting_periods": [ { "waiting_period_enrollment_type": "new_member", "waiting_period_rule": "hire_date" }, { "waiting_period_amount": 0, "waiting_period_enrollment_type": "current_member", "waiting_period_rule": "after_waiting_period", "waiting_period_unit": "day" } ] } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupPlanResult" } } }, "description": "Successful Response - Returns all matching Plans" } }, "summary": "Get a list of all Group Plans", "tags": [ "Group Plans & Enrollment" ] }, "x-summary": "List Group Plans" }, "/api/v1/groups/{group_id}/platform_account_structures": { "get": { "description": "Retrieve a Platform Account Structure by Group", "operationId": "getPlatformAccountStructureByGroup", "parameters": [ { "description": "The unique identifier of the group you want to get a platform account structure for", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2705bb9f-3c90-4400-a4e7-0bc9d48e677c", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "example": "2022-01-01", "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "account_structure": { "account_structure_fields": [ { "existing_value_set": [ "North Branch", "HQ", "Springfield" ], "field_name": "BranchName", "field_type": "string" } ], "plans": { "group_dental_plans": [ "Dental Plan Low", "Dental Plan High" ], "group_medical_plans": [ "Medical Plan A", "Medical Plan B" ] } }, "group_id": "2c4d5515-6bf8-4f8c-821a-9c56374198b2", "id": "2705bb9f-3c90-4400-a4e7-0bc9d48e677c", "version": "7a2b0437-4027-4251-9e71-85384c0eb1c9" }, "schema": { "$ref": "#/components/schemas/PlatformAccountStructureResult" } } }, "description": "Successful Response - Returns a Platform Account Structure" } }, "summary": "Get a Platform Account Structure by Group", "tags": [ "Platform Account Structure" ] }, "post": { "description": "Create a new Platform Account Structure", "operationId": "createNewPlatformAccountStructure", "parameters": [ { "description": "Unique identifier of the associated group in the Noyo system", "in": "path", "name": "group_id", "required": true, "schema": { "example": "3e366930-df4d-11eb-ba80-0242ac130004", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "account_structure": { "account_structure_fields": [ { "existing_value_set": [ "North Branch", "HQ", "Springfield" ], "field_name": "BranchName", "field_type": "string" } ], "plans": { "group_dental_plans": [ "Dental Plan Low", "Dental Plan High" ], "group_medical_plans": [ "Medical Plan A", "Medical Plan B" ] } }, "start_date": "2021-01-12" } } }, "schema": { "$ref": "#/components/schemas/PlatformAccountStructureCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "account_structure": { "account_structure_fields": [ { "existing_value_set": [ "North Branch", "HQ", "Springfield" ], "field_name": "BranchName", "field_type": "string" } ], "plans": { "group_dental_plans": [ "Dental Plan Low", "Dental Plan High" ], "group_medical_plans": [ "Medical Plan A", "Medical Plan B" ] } }, "created": 1626281253, "group_id": "3e366930-df4d-11eb-ba80-0242ac130004", "id": "3e366930-df4d-11eb-ba80-0242ac130004", "modified": 1626281253, "version": "5200a894-81c5-4c41-8519-86c32e9a9965" }, "schema": { "$ref": "#/components/schemas/PlatformAccountStructureResult" } } }, "description": "Successful Response - Returns the new Platform Account Structure" } }, "summary": "Create a new Platform Account Structure", "tags": [ "Platform Account Structure" ] } }, "/api/v1/groups/{group_id}/renewal_decisions": { "get": { "description": "Returns all renewal decisions for a group. This includes the status, which determines whether the carrier is ready to accept member requests for the new plan year. If the status is `not_ready`, Noyo will return one or more issues, each with a level and message.", "operationId": "getRenewalDecisionsByGroup", "parameters": [ { "description": "The unique identifier of the group for which you are retrieving renewal decisions", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "Renewal date to filter by, exact match", "in": "query", "name": "renewal_date", "required": false, "schema": { "example": "Sat, 02 Jan 2021 00:00:00 GMT", "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "body": { "carriers": [ { "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4", "lines_of_coverage": { "dental": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Dental Plus Plan", "plan_id": "44bc0f4a-0a94-11ec-9a03-0242ac130003" } ] }, "medical": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Select Plus PPO HDHP Gold BRJJ /C38", "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468" }, { "name": "Select Plus PPO HDHP Silver BRJJ /C38", "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2" }, { "name": "Select Plus PPO HDHP Bronze BRJJ /C38", "plan_id": "19437852-3795-4cb4-939c-a86543eabee0" } ] } } } ] }, "created": 1557862286, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6", "issues": [ { "level": "error", "message": "Life open enrollment start date is 2021-08-01 in carrier system" }, { "level": "error", "message": "LTD Plan not available yet in carrier system" } ], "modified": 1557862286, "renewal_date": "2022-01-01", "status": "not_ready", "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedRenewalDecisionResult" } } }, "description": "Successful Response - Returns the found renewal decisions." } }, "summary": "Get renewal decisions by group", "tags": [ "Renewal Decisions" ] }, "post": { "description": "Create a new renewal decision for a given renewal date.", "operationId": "createNewRenewalDecision", "parameters": [ { "description": "The unique identifier of the group for which you are creating a new renewal decision", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "body": { "carriers": [ { "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4", "lines_of_coverage": { "dental": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Dental Plus Plan", "plan_type": "ppo" } ] }, "medical": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468" }, { "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2" }, { "metal_tier": "bronze", "name": "Select Plus PPO HDHP Bronze BRJJ /C38", "plan_type": "ppo" } ] } } } ] }, "renewal_date": "2022-01-01" } } }, "schema": { "$ref": "#/components/schemas/RenewalDecisionCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "body": { "carriers": [ { "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4", "lines_of_coverage": { "dental": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Dental Plus Plan", "plan_id": "44bc0f4a-0a94-11ec-9a03-0242ac130003" } ] }, "medical": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Select Plus PPO HDHP Gold BRJJ /C38", "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468" }, { "name": "Select Plus PPO HDHP Silver BRJJ /C38", "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2" }, { "name": "Select Plus PPO HDHP Bronze BRJJ /C38", "plan_id": "19437852-3795-4cb4-939c-a86543eabee0" } ] } } } ] }, "created": 1557862286, "group_id": "2c4d5515-6bf8-4f8c-821a-9c56374198b2", "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6", "issues": [], "modified": 1557862286, "renewal_date": "2022-01-01", "status": "submitted", "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e" }, "schema": { "$ref": "#/components/schemas/RenewalDecisionResult" } } }, "description": "Successful Response - Returns the new Renewal Decision" } }, "summary": "Create a new renewal decision", "tags": [ "Renewal Decisions" ] }, "x-summary": "Renewal decisions by group" }, "/api/v1/groups/{group_id}/renewal_decisions/{renewal_decision_id}": { "get": { "description": "Returns a renewal decision by ID.", "operationId": "getRenewalDecision", "parameters": [ { "description": "The unique identifier of the group for which you are retrieving a renewal decision", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the renewal decision you want to retrieve", "in": "path", "name": "renewal_decision_id", "required": true, "schema": { "example": "4093a441-d4c8-4c8a-24d1-e7a132fb1bc2", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "body": { "carriers": [ { "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4", "lines_of_coverage": { "dental": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Dental Plus Plan", "plan_id": "81803f12-0a96-11ec-9a03-0242ac130003" } ] }, "medical": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Select Plus PPO HDHP Gold BRJJ /C38", "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468" }, { "name": "Select Plus PPO HDHP Silver BRJJ /C38", "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2" }, { "name": "Select Plus PPO HDHP Bronze BRJJ /C38", "plan_id": "19437852-3795-4cb4-939c-a86543eabee0" } ] } } } ] }, "created": 1557862286, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6", "issues": [ { "level": "error", "message": "Life open enrollment start date is 2021-08-01 in carrier system" }, { "level": "error", "message": "LTD Plan not available yet in carrier system" } ], "modified": 1557862286, "renewal_date": "2022-01-01", "status": "not_ready", "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e" }, "schema": { "$ref": "#/components/schemas/RenewalDecisionResult" } } }, "description": "Successful Response - Returns the found renewal decision." } }, "summary": "Get an existing renewal decision by id", "tags": [ "Renewal Decisions" ] }, "x-summary": "Renewal decisions by id" }, "/api/v1/groups/{group_id}/{version}": { "put": { "description": "Edit a group based on the ID provided. The version parameter must match the latest group version.", "operationId": "editGroup", "parameters": [ { "description": "The unique identifier of the group to be edited", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "Unique version of the group you want to edit", "in": "path", "name": "version", "required": true, "schema": { "example": "6b72d72d-cc99-4df6-8152-7183e824c80c", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "dba_name": "Test Corporation", "federal_ein": "221111111" } } }, "schema": { "$ref": "#/components/schemas/GroupEditRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "created": 1557512389, "dba_name": "Test Corporation", "federal_ein": "221111111", "id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "modified": 1543215342, "name": "Test Company", "organization_id": "d61fa455-adf4-4dc4-8c57-6d779ba9475e", "sic_code": "7371", "version": "097abf09-336a-4ea1-95d5-633107feb562" }, "schema": { "$ref": "#/components/schemas/GroupResult" } } }, "description": "Successful Response - Returns the modified Group" } }, "summary": "Edit an existing Group", "tags": [ "Group Configuration" ] }, "x-summary": "Edit Group" }, "/api/v1/individual_enrollments/{individual_enrollment_id}": { "get": { "description": "Returns the latest version of a single individual enrollment based on the ID provided.", "operationId": "getIndividualEnrollment", "parameters": [ { "description": "Unique identifier of the individual enrollment", "in": "path", "name": "individual_enrollment_id", "required": true, "schema": { "example": "6670f290-4236-4690-bece-a110f9ad924b", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "cobra_enrollment": {}, "created": 1557512389, "effective_end_date": "2019-10-01", "effective_start_date": "2018-10-01", "enroll_data": { "premium": { "amount": 50, "unit": "Month" } }, "group_enrollment_id": "7499ea07-76c9-40f2-992b-952259e98384", "id": "6670f290-4236-4690-bece-a110f9ad924b", "individual_enrollment_configuration": {}, "individual_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "individual_type": "employee", "line_of_coverage": "medical", "modified": 1564440756, "plan_id": "b988cd26-121a-4dd6-b0be-09399f6ecc0a", "status": "active", "version": "27bbf929-78ca-4339-8bb3-39b75f92c4a4" }, "schema": { "$ref": "#/components/schemas/PublicIndividualEnrollmentResultWithConfig" } } }, "description": "Successful Response - Returns a single Individual Enrollment" } }, "summary": "Get a single Individual Enrollment", "tags": [ "Individual Enrollments" ] }, "x-summary": "Get Individual Enrollment" }, "/api/v1/member_requests": { "get": { "description": "Returns a list of all member requests for a given organization. Each member request may have one or more associated member transactions.", "operationId": "getOrganizationMemberRequestList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "Unique identifier of the employee in Noyo for which you would like to filter", "in": "query", "name": "employee_id", "required": false, "schema": { "format": "uuid", "type": "string" } }, { "description": "The member request status for which you would like to filter", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "The member request type for which you would like to filter", "in": "query", "name": "request_type", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "body": { "coverages": [ { "carrier_config": { "bill_group": "1000001", "member_group": "99999" }, "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16", "lines_of_coverage": { "dental": { "waiving_members": [ { "id": "f471a562-fa8f-41c9-93fd-12b372e16c72", "member_type": "employee", "reason": "other-spouse-group" } ] } } } ] }, "completed": 1557565200, "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "4f57e463-f4d5-4255-83d4-806b0cabaac5", "modified": 1557565200, "request_type": "new_hire", "status": "processing", "transactions": [ "a6e30204-87b2-4802-95a4-a156bd0f7435" ] }, { "body": { "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "last_work_date": "2018-01-15", "reason": "voluntary" }, "completed": 1557565200, "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557565200, "request_type": "termination", "status": "processing", "transactions": [ "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd" ] } ] }, "schema": { "$ref": "#/components/schemas/PaginatedMemberRequestResult" } } }, "description": "Successful Response - Returns all matching Member Requests" } }, "summary": "Get all Member Requests for Organization", "tags": [ "Member Requests" ] }, "x-summary": "List Member Requests, by authenticated organization" }, "/api/v1/member_requests/{request_id}": { "get": { "description": "Returns the latest version of a single member request based on the ID provided.", "operationId": "getMemberRequest", "parameters": [ { "description": "The unique identifier of the member request you would like to view", "in": "path", "name": "request_id", "required": true, "schema": { "example": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "body": { "employee_id": "6dc22bed-27fc-458c-b732-bdaf5b5a1031", "last_work_date": "2018-01-15", "reason": "voluntary" }, "completed": 1557565200, "created": 1557512389, "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557565200, "request_type": "termination", "status": "processing", "transactions": [ "f4ecdaa5-e019-4a24-98c7-2caee9a58ccd" ] }, "schema": { "$ref": "#/components/schemas/MemberRequestResult" } } }, "description": "Successful Response - Returns a single Member Request" } }, "summary": "Get a single Member Request", "tags": [ "Member Requests" ] }, "x-summary": "Get Single Member Request" }, "/api/v1/member_requests/{request_id}/member_transactions": { "get": { "description": "Returns a list of all member transactions for a given member request.", "operationId": "getMemberTransactionsByMemberRequestList", "parameters": [ { "description": "The unique identifier of the member request for which you would like to view member transaction", "in": "path", "name": "request_id", "required": true, "schema": { "example": "a6e30204-87b2-4802-95a4-a156bd0f7435", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "body": { "coverages": [ { "carrier_config": { "bill_group": "1000001", "member_group": "99999" }, "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16", "lines_of_coverage": { "dental": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "2e6a04b6-21f3-40d7-a9e2-735196cc451b" } ], "waiving_members": [] }, "medical": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "1873df52-c9e9-4e3a-995c-f47f32d0bd62" } ], "waiving_members": [] }, "vision": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "9cb64800-022e-40af-ab80-8d945e430592" } ], "waiving_members": [] } } } ] }, "carrier_id": "478e066e-9696-490e-b60f-47f40c96dc7c", "created": 1557512389, "employee_id": "25434576-e85d-481b-a825-962fd575046f", "id": "a6e30204-87b2-4802-95a4-a156bd0f7435", "lines_of_coverage": [ "medical", "dental", "vision" ], "member_request_id": "bba6ea27-4004-4a52-a3d9-f986ace0d3da", "modified": 1564440756, "status": "processing" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedMemberTransactionResult" } } }, "description": "Successful Response - Returns all matching Member Transactions" } }, "summary": "Get a list of all Member Transactions", "tags": [ "Member Transactions" ] }, "x-summary": "List Member Transactions By Member Request" }, "/api/v1/member_snapshots": { "get": { "description": "Returns a list with metadata for all member snapshots.", "operationId": "getMemberSnapshotsList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 2 }, "response": [ { "created": 1599184829, "employee_id": "7f39b5e0-460d-49e2-83b7-a1b6f2726b12", "id": "bc4aea3e-f728-4b05-85dc-e1ea14456e83", "modified": 1599184829, "status": "processing", "version": "431b7d10-3da6-4c5e-bb2f-58a6ebb1224f" }, { "created": 1557512389, "employee_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "modified": 1564440756, "status": "completed", "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedMemberSnapshotResult" } } }, "description": "Successful Response - Returns metadata for any matching Member Snapshots" } }, "summary": "Get all Member Snapshots", "tags": [ "Member Snapshot" ] }, "x-summary": "Get all member snapshots" }, "/api/v1/member_snapshots/{snapshot_id}": { "get": { "description": "Get a Member Snapshot by ID", "operationId": "getMemberSnapshot", "parameters": [ { "description": "The unique identifier of the member snapshot", "in": "path", "name": "snapshot_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "created": 1656030390, "employee_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "id": "7bea80ac-499d-560b-5512-60be9e2349cb", "member_snapshot": { "coverages": [ { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "cobra_enrolled": true, "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "individual_type": "employee", "latest_change_effective_date": "2022-02-13" }, { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "9da3ea58-73fc-4a99-82c3-489bb4a4c1d4", "individual_type": "dependent" } ], "line_of_coverage": "medical", "plan_id": "4bf04f73-0aad-48ac-b28a-e5f4def7c5e9", "signature_date": "2021-12-23" }, { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_type": "employee" }, { "effective_end_date": "2021-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_id": "9da3ea58-73fc-4a99-82c3-489bb4a4c1d4", "individual_type": "dependent" } ], "line_of_coverage": "dental", "plan_name": "DHMO Smile Plus", "signature_date": "2021-12-23" }, { "carrier_id": "4d4d815b-ae8f-430c-901f-1c9d5ee3f4f1", "enrolled_members": [ { "effective_end_date": "9999-12-31", "effective_start_date": "2022-01-01", "event_id": "1", "individual_type": "employee", "volume": 50000 } ], "line_of_coverage": "life", "plan_name": "50k Employee Basic Life", "signature_date": "2021-12-23" } ], "dependents": [ { "event_id": "1", "id": "ab740704-7c37-4010-92b3-d22c6926be3e", "person": { "contact": { "email_address": "jamie@testemail.com", "email_address_type": "home", "home_phone": "+12065551234" }, "date_of_birth": "1990-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": "married", "sex": "F", "ssn": "987654321" }, "relationship": "spouse" } ], "employee": { "classifications": { "BranchName": "HQ", "Department": "Sales" }, "employment": { "employment_dates": { "full_time_start": "2015-01-01", "hire_date": "2014-12-10" }, "employment_status": "full-time", "hours_worked": 50, "occupation": "Senior Analyst", "salary": { "amount": 55000, "effective_date": "2022-01-31", "type": "salary", "unit": "annual" } }, "event_id": "1", "group_id": "d0ec3837-3499-4a2f-8c58-966ef7e46d95", "id": "6e7a80fc-473e-460a-8368-454e9e8dc9cb", "person": { "contact": { "email_address": "david@testemail.com", "email_address_type": "home", "home_phone": "+12065551234", "preferred_method": "email", "work_phone": "+12065559876" }, "date_of_birth": "1985-06-22", "first_name": "David", "home_address": { "city": "San Francisco", "county": "San Francisco", "state": "CA", "street_one": "1234 Home Ave", "zip_code": "94107" }, "last_name": "Johnson", "marital_status": "married", "middle_name": "A", "sex": "M", "ssn": "123456789", "suffix": "Jr" } }, "events": [ { "date": "2022-01-01", "id": "1", "reason": "open_enrollment", "type": "enrollment" } ], "snapshot_mode": "current_open" }, "modified": 1656030390, "status": "processing", "version": "271c60d6-f009-4b3d-8bba-aac49b2dd9a4" }, "schema": { "$ref": "#/components/schemas/MemberSnapshotResult" } } }, "description": "Successful Response - Returns the Member Snapshot contents" } }, "summary": "Get a Member Snapshot", "tags": [ "Member Snapshot" ] }, "x-summary": "Get a single member snapshot" }, "/api/v1/member_transactions": { "get": { "description": "Returns a list of all member transactions", "operationId": "getMemberTransactionsList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "Comma-separated member transaction IDs you would like to view", "in": "query", "name": "ids", "required": false, "schema": { "type": "string" } }, { "description": "Comma-separated list of status details to be filtered on", "in": "query", "name": "status_details", "required": false, "schema": { "type": "string" } }, { "description": "indicates whether the filter should operate on the current status detail or the entire history of status details", "in": "query", "name": "current_status_detail", "required": false, "schema": { "type": "boolean" } }, { "description": "Comma-separated list of carrier IDs to be filtered on", "in": "query", "name": "carrier_ids", "required": false, "schema": { "type": "string" } }, { "description": "Transaction type of the member transaction", "in": "query", "name": "transaction_type", "required": false, "schema": { "type": "string" } }, { "description": "Earliest date that the transaction was created", "in": "query", "name": "transaction_min_date", "required": false, "schema": { "type": "string" } }, { "description": "Latest date that the transaction was created", "in": "query", "name": "transaction_max_date", "required": false, "schema": { "type": "string" } }, { "description": "Earliest date that the transaction entered the given status detail(s)", "in": "query", "name": "status_detail_min_date", "required": false, "schema": { "type": "string" } }, { "description": "Latest date that the transaction entered the given status detail(s)", "in": "query", "name": "status_detail_max_date", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "body": { "coverages": [ { "carrier_config": { "bill_group": "1000001", "member_group": "99999" }, "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16", "lines_of_coverage": { "dental": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "2e6a04b6-21f3-40d7-a9e2-735196cc451b" } ], "waiving_members": [] }, "medical": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "1873df52-c9e9-4e3a-995c-f47f32d0bd62" } ], "waiving_members": [] }, "vision": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "9cb64800-022e-40af-ab80-8d945e430592" } ], "waiving_members": [] } } } ] }, "carrier_id": "478e066e-9696-490e-b60f-47f40c96dc7c", "created": 1557512389, "employee_id": "25434576-e85d-481b-a825-962fd575046f", "id": "a6e30204-87b2-4802-95a4-a156bd0f7435", "lines_of_coverage": [ "medical", "dental", "vision" ], "member_request_id": "bba6ea27-4004-4a52-a3d9-f986ace0d3da", "modified": 1564440756, "status": "processing" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedMemberTransactionResult" } } }, "description": "Successful Response - Returns all matching Member Transactions" } }, "summary": "Get a list of all Member Transactions", "tags": [ "Member Transactions" ] }, "x-summary": "List Member Transactions" }, "/api/v1/member_transactions/{transaction_id}": { "get": { "description": "Returns the latest version of a single member transaction based on the ID provided.", "operationId": "getMemberTransaction", "parameters": [ { "description": "The unique identifier of the member transaction you would like to view", "in": "path", "name": "transaction_id", "required": true, "schema": { "example": "a6e30204-87b2-4802-95a4-a156bd0f7435", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "body": { "coverages": [ { "carrier_config": { "bill_group": "1000001", "member_group": "99999" }, "carrier_id": "d0003042-eaae-4491-b219-4825456a3d16", "lines_of_coverage": { "dental": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "2e6a04b6-21f3-40d7-a9e2-735196cc451b" } ], "waiving_members": [] }, "medical": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "1873df52-c9e9-4e3a-995c-f47f32d0bd62" } ], "waiving_members": [] }, "vision": { "enrolling_members": [ { "id": "25434576-e85d-481b-a825-962fd575046f", "member_type": "employee", "plan_id": "9cb64800-022e-40af-ab80-8d945e430592" } ], "waiving_members": [] } } } ] }, "carrier_id": "478e066e-9696-490e-b60f-47f40c96dc7c", "created": 1557512389, "employee_id": "25434576-e85d-481b-a825-962fd575046f", "id": "a6e30204-87b2-4802-95a4-a156bd0f7435", "lines_of_coverage": [ "medical", "dental", "vision" ], "member_request_id": "bba6ea27-4004-4a52-a3d9-f986ace0d3da", "modified": 1564440756, "status": "processing" }, "schema": { "$ref": "#/components/schemas/MemberTransactionResult" } } }, "description": "Successful Response - Returns a single Member Transaction" } }, "summary": "Get a single Member Transaction", "tags": [ "Member Transactions" ] }, "x-summary": "Get Single Member Transaction" }, "/api/v1/member_transactions/{transaction_id}/status_details": { "get": { "description": "Returns a list of all status details for a given transaction.", "operationId": "getStatusDetailList", "parameters": [ { "description": "The unique identifier of the member transaction", "in": "path", "name": "transaction_id", "required": true, "schema": { "example": "136e34f9-1eb5-4b31-af53-b3a37ef225ba", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "The attribute on which to sort the status details", "in": "query", "name": "sort_by", "required": false, "schema": { "type": "string" } }, { "description": "Either asc or desc, to denote the data's direction", "in": "query", "name": "sort_direction", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 3 }, "response": [ { "event_created": 1673510745, "status_detail": "noyo_accepted" }, { "event_created": 1673510857, "status_detail": "carrier_accepted" }, { "event_created": 1673510869, "status_detail": "carrier_processing" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedStatusDetailResult" } } }, "description": "Successful Response - Returns all Status Details" } }, "summary": "Get a list of all Status Details", "tags": [ "Status Detail" ] }, "x-summary": "Get Status Details" }, "/api/v1/member_transactions/{transaction_id}/status_details/latest": { "get": { "description": "Returns the latest status detail for a given transaction.", "operationId": "getLatestStatusDetail", "parameters": [ { "description": "The unique identifier of the member transaction", "in": "path", "name": "transaction_id", "required": true, "schema": { "example": "136e34f9-1eb5-4b31-af53-b3a37ef225ba", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "event_created": 1673510869, "status_detail": "carrier_accepted" }, "schema": { "$ref": "#/components/schemas/StatusDetailResult" } } }, "description": "Successful Response - Returns the latest Status Detail" } }, "summary": "Get latest Status Detail", "tags": [ "Status Detail" ] }, "x-summary": "Get Latest Status Detail" }, "/api/v1/plans/{plan_id}": { "get": { "description": "Returns the group plan specified by unique identifier", "operationId": "getGroupPlanById", "parameters": [ { "description": "The unique identifier of the group plan you would like to view", "in": "path", "name": "plan_id", "required": true, "schema": { "example": "31559b4b-e45a-4df8-84f6-2220d7ed0c3a", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "plan": { "cobra_rules": { "eligible": false }, "code": "D1", "created": 1554175253, "effective_end_date": "9999-12-31", "effective_start_date": "2020-01-01", "eligible_member_types": [ "employee" ], "group_enrollment_id": "31559b4b-e45a-4df8-84f6-2220d7ed0c3a", "id": "5ba915fc-afe8-4572-a60f-61ee5883e100", "line_of_coverage": "dental", "modified": 1554175253, "name": "Dental - Employee", "network": "Dental PPO Network", "plan_type": "ppo", "status": "active", "termination_policy": "end_of_month", "version": "1bf06a82-8d81-4849-91d3-47c60fdce605", "voluntary": false, "waiting_periods": [ { "waiting_period_enrollment_type": "new_member", "waiting_period_rule": "hire_date" }, { "waiting_period_amount": 0, "waiting_period_enrollment_type": "current_member", "waiting_period_rule": "after_waiting_period", "waiting_period_unit": "day" } ] } }, "schema": { "$ref": "#/components/schemas/SingleGroupPlanResult" } } }, "description": "Successful Response - Returns matching Group Plan" } }, "summary": "Get a Group Plan by ID", "tags": [ "Group Plans & Enrollment" ] }, "x-summary": "Get Single Group Plan" }, "/api/v1/platform_account_structures/{platform_account_structure_id}": { "get": { "description": "Retrieve a Platform Account Structure", "operationId": "getPlatformAccountStructure", "parameters": [ { "description": "The unique identifier of the platform account structure to be retrieved.", "in": "path", "name": "platform_account_structure_id", "required": true, "schema": { "example": "2705bb9f-3c90-4400-a4e7-0bc9d48e677c", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "example": "2022-01-01", "format": "date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "account_structure": { "account_structure_fields": [ { "existing_value_set": [ "North Branch", "HQ", "Springfield" ], "field_name": "BranchName", "field_type": "string" } ], "plans": { "group_dental_plans": [ "Dental Plan Low", "Dental Plan High" ], "group_medical_plans": [ "Medical Plan A", "Medical Plan B" ] } }, "group_id": "2c4d5515-6bf8-4f8c-821a-9c56374198b2", "id": "2705bb9f-3c90-4400-a4e7-0bc9d48e677c", "version": "7a2b0437-4027-4251-9e71-85384c0eb1c9" }, "schema": { "$ref": "#/components/schemas/PlatformAccountStructureResult" } } }, "description": "Successful Response - Returns the matching Platform Account Structure" } }, "summary": "Get a single Platform Account Structure", "tags": [ "Platform Account Structure" ] } }, "/api/v1/platform_account_structures/{platform_account_structure_id}/{version}": { "put": { "description": "Edit a platform account structure based on the ID provided. The version parameter must match the latest platform account structure version.", "operationId": "editPlatformAccountStructure", "parameters": [ { "description": "Unique identifier of the platform account structure in the Noyo system", "in": "path", "name": "platform_account_structure_id", "required": true, "schema": { "example": "3e366930-df4d-11eb-ba80-0242ac130004", "format": "uuid", "type": "string" } }, { "description": "Current version of the model", "in": "path", "name": "version", "required": true, "schema": { "example": "5200a894-81c5-4c41-8519-86c32e9a9965", "format": "uuid", "type": "string" } }, { "description": "The relative date on which to view the state of the record", "in": "query", "name": "effective_date", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "account_structure": { "account_structure_fields": [ { "existing_value_set": [ "North Branch", "HQ", "Springfield" ], "field_name": "BranchName", "field_type": "date" } ], "plans": { "group_dental_plans": [ "Dental Plan Low", "Dental Plan High" ], "group_medical_plans": [ "Medical Plan A", "Medical Plan B" ] } } } } }, "schema": { "$ref": "#/components/schemas/PlatformAccountStructureEditRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "account_structure": { "account_structure_fields": [ { "existing_value_set": [ "North Branch", "HQ", "Springfield" ], "field_name": "BranchName", "field_type": "date" } ], "plans": { "group_dental_plans": [ "Dental Plan Low", "Dental Plan High" ], "group_medical_plans": [ "Medical Plan A", "Medical Plan B" ] } }, "created": 1557512389, "group_id": "3e366930-df4d-11eb-ba80-0242ac130004", "id": "3e366930-df4d-11eb-ba80-0242ac130004", "modified": 1543215342, "version": "5200a894-81c5-4c41-8519-86c32e9a9965" }, "schema": { "$ref": "#/components/schemas/PlatformAccountStructureResult" } } }, "description": "Successful Response - Returns the modified Platform Account Structure" } }, "summary": "Edit an existing Platform Account Structure", "tags": [ "Platform Account Structure" ] } }, "/api/v1/reconciliation_issues": { "get": { "description": "Returns a list of all reconciliation issues matching the given query", "operationId": "getReconciliationIssuesList", "parameters": [ { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } }, { "description": "Status of the reconciliation issues", "in": "query", "name": "status", "required": false, "schema": { "type": "string" } }, { "description": "Status grouping of the reconciliation issues", "in": "query", "name": "status_grouping", "required": false, "schema": { "type": "string" } }, { "description": "Type grouping of the reconciliation issues", "in": "query", "name": "type_grouping", "required": false, "schema": { "type": "string" } }, { "description": "The unique identifier of the carrier for which you would like to view reconciliation issues", "in": "query", "name": "carrier_id", "required": false, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the group for which you would like to view reconciliation issues", "in": "query", "name": "group_id", "required": false, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "Unique identifier of the model that is the subject of the reconciliation issue", "in": "query", "name": "subject_id", "required": false, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The type of the model that is the subject of the reconciliation issue", "in": "query", "name": "subject_type", "required": false, "schema": { "type": "string" } }, { "description": "The categorization of the reconciliation issue", "in": "query", "name": "reconciliation_issue_type", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "body": { "carrier_value": "2020-01-01", "distributor_value": "2020-02-01" }, "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "context": "", "created": 1557862286, "group_id": "436fb487-bb75-42d4-9651-7b1471a8940e", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557862286, "reconciliation_issue_type": "individual_enrollment_effective_start_date_mismatch", "status": "pending_resolution", "subject_id": "7027d416-3bed-43e8-b824-508d9c0d323e", "subject_type": "IndividualEnrollment", "version": "ea38e798-cd61-4fa2-b485-d1c5b87a61af" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedReconciliationIssuePublicResult" } } }, "description": "Successful Response - Returns all matching Reconciliation Issues" } }, "summary": "List Reconciliation Issues", "tags": [ "Reconcilation Issues" ] } }, "/api/v1/reconciliation_issues/{reconciliation_issue_id}": { "get": { "description": "Returns the latest version of a single reconciliation issue based on the ID provided", "operationId": "getReconciliationIssue", "parameters": [ { "description": "The unique identifier of the reconciliation issue you would like to retrieve", "in": "path", "name": "reconciliation_issue_id", "required": true, "schema": { "example": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "body": { "carrier_value": "2020-01-01", "distributor_value": "2020-02-01" }, "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "context": "", "created": 1557862286, "group_id": "436fb487-bb75-42d4-9651-7b1471a8940e", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557862286, "reconciliation_issue_type": "individual_enrollment_effective_start_date_mismatch", "status": "pending_resolution", "subject_id": "7027d416-3bed-43e8-b824-508d9c0d323e", "subject_type": "IndividualEnrollment", "version": "ea38e798-cd61-4fa2-b485-d1c5b87a61af" }, "schema": { "$ref": "#/components/schemas/ReconciliationIssuePublicResult" } } }, "description": "Successful Response - Returns a single Reconciliation Issue" } }, "summary": "Get Reconciliation Issue", "tags": [ "Reconcilation Issues" ] } }, "/api/v1/reconciliation_issues/{reconciliation_issue_id}/ack": { "put": { "description": "Acknowledge receipt of a reconciliation issue", "operationId": "acknowledgeReconciliationIssue", "parameters": [ { "description": "Unique identifier of the reconciliation issue in the Noyo system", "in": "path", "name": "reconciliation_issue_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "An empty request, simply acknowledging reconciliation issue receipt", "value": null } }, "schema": { "$ref": "#/components/schemas/ReconciliationIssueAckRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "body": { "carrier_value": "2020-01-01", "distributor_value": "2020-02-01" }, "carrier_id": "8fac0992-933a-4743-8dab-0d606ef2569e", "context": "", "created": 1557862286, "group_id": "436fb487-bb75-42d4-9651-7b1471a8940e", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557862286, "reconciliation_issue_type": "individual_enrollment_effective_start_date_mismatch", "status": "acknowledged", "subject_id": "7027d416-3bed-43e8-b824-508d9c0d323e", "subject_type": "IndividualEnrollment", "version": "ea38e798-cd61-4fa2-b485-d1c5b87a61af" }, "schema": { "$ref": "#/components/schemas/ReconciliationIssuePublicResult" } } }, "description": "Successful Response - Returns the updated Reconciliation Issue" } }, "summary": "Acknowledge Reconciliation Issue", "tags": [ "Reconciliation Issues" ] } }, "/api/v1/reconciliation_issues/{reconciliation_issue_id}/request_outcome": { "put": { "description": "Request a new outcome attempt for a reconciliation issue", "operationId": "requestReconciliationIssueOutcome", "parameters": [ { "description": "The unique identifier of the associated reconciliation issue", "in": "path", "name": "reconciliation_issue_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "summary": "A reconciliation issue resolution body", "value": { "distributor_action": "will_update", "outcome": "distributor_change", "request_context": "After checking with the team, this looks like an issue on our end, will update", "resolution_type": "offline" } } }, "schema": { "$ref": "#/components/schemas/ReconciliationIssueResolutionRequestOutcome" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "example": { "distributor_action": "will_update", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "outcome": "distributor_change", "reconciliation_issue_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "request_context": "After checking with the team, this looks like an issue on our end, will update", "resolution_type": "offline", "result": {}, "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" }, "schema": { "$ref": "#/components/schemas/ReconciliationIssueResolutionResult" } } }, "description": "Successful Response - Returns the new Reconciliation Issue Resolution" } }, "summary": "Request Reconciliation Issue Outcome", "tags": [ "Reconciliation Issues" ] }, "x-summary": "Request a particular reconciliation issue outcome" }, "/api/v1/reconciliation_issues/{reconciliation_issue_id}/resolutions": { "get": { "description": "Returns a list of all resolutions for a given reconciliation issue.", "operationId": "getReconciliationIssueResolutionsList", "parameters": [ { "description": "The unique identifier of the reconciliation issue for which you would like to view resolutions", "in": "path", "name": "reconciliation_issue_id", "required": true, "schema": { "example": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "automated_change_id": "bd957820-4652-4ee7-8a3a-6413df21e28d", "automated_change_type": "member_request", "distributor_action": "no_update", "id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4", "outcome": "carrier_change", "reconciliation_issue_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "resolution_type": "member_request", "result": { "context": "Something here explaining the resolution", "type": "note" }, "version": "6260146a-3486-4c3d-b2a6-fcd3f8c84043" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedReconciliationIssueResolutionResult" } } }, "description": "Successful Response - Returns all matching reconciliation issue resolutions" } }, "summary": "Get a list of all reconciliation issue resolutions under a single reconciliation issue", "tags": [ "Reconciliation Issues" ] }, "x-summary": "Get a list of reconciliation issue resolutions" }, "/api/v1/renewal_decisions": { "get": { "description": "Returns all renewal decisions. This includes the status, which determines whether the carrier is ready to accept member requests for the new plan year. If the status is `not_ready`, Noyo will return one or more issues, each with a level and message.", "operationId": "getRenewalDecisions", "parameters": [ { "description": "Group name to filter by, exact match", "in": "query", "name": "group_name", "required": false, "schema": { "example": "Company Inc", "format": "string", "type": "string" } }, { "description": "Status to filter by, exact match", "in": "query", "name": "status", "required": false, "schema": { "example": "ready", "format": "string", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "body": { "carriers": [ { "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4", "lines_of_coverage": { "dental": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Dental Plus Plan" } ] }, "medical": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468" }, { "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2" }, { "name": "Select Plus PPO HDHP Bronze BRJJ /C38" } ] } } } ] }, "created": 1557862286, "group_id": "2613a221-d3c8-4c8a-86d5-e7e885fd1da9", "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6", "issues": [ { "level": "error", "message": "Life open enrollment start date is 2021-08-01 in carrier system" }, { "level": "error", "message": "LTD Plan not available yet in carrier system" } ], "modified": 1557862286, "renewal_date": "2022-01-01", "status": "not_ready", "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedRenewalDecisionResult" } } }, "description": "Successful Response - Returns the found renewal decisions." } }, "summary": "Get renewal decisions", "tags": [ "Renewal Decisions" ] } }, "/api/v1/renewal_decisions/{renewal_decision_id}/{version}": { "put": { "description": "Edit an existing renewal decision for a group.", "operationId": "editRenewalDecision", "parameters": [ { "description": "The unique identifier of the renewal decision you want to edit", "in": "path", "name": "renewal_decision_id", "required": true, "schema": { "example": "4093a441-d4c8-4c8a-24d1-e7a132fb1bc2", "format": "uuid", "type": "string" } }, { "description": "The unique identifier of the renewal decision version you want to edit", "in": "path", "name": "version", "required": true, "schema": { "example": "d012e6ac-05dd-4cbe-8666-940af78c9e56", "format": "uuid", "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "success": { "value": { "body": { "carriers": [ { "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4", "lines_of_coverage": { "dental": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Dental Plus Plan", "plan_type": "ppo" } ] }, "medical": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468" }, { "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2" }, { "metal_tier": "bronze", "name": "Select Plus PPO HDHP Bronze BRJJ /C38", "plan_type": "ppo" } ] } } } ] }, "renewal_date": "2022-01-01" } } }, "schema": { "$ref": "#/components/schemas/RenewalDecisionEditRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "body": { "carriers": [ { "carrier_id": "bf81f0c4-3105-4240-b62b-aa6de3f607e4", "lines_of_coverage": { "dental": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Dental Plus Plan", "plan_id": "44bc0f4a-0a94-11ec-9a03-0242ac130003" } ] }, "medical": { "open_enrollment_end_date": "2022-01-31", "open_enrollment_start_date": "2022-01-01", "plans": [ { "name": "Select Plus PPO HDHP Gold BRJJ /C38", "plan_id": "818e52d4-6c34-4914-b716-a3047c85e468" }, { "name": "Select Plus PPO HDHP Silver BRJJ /C38", "plan_id": "f9897240-87f8-4d9d-a68f-58bc445fe0b2" }, { "name": "Select Plus PPO HDHP Bronze BRJJ /C38", "plan_id": "19437852-3795-4cb4-939c-a86543eabee0" } ] } } } ] }, "created": 1557862286, "group_id": "2c4d5515-6bf8-4f8c-821a-9c56374198b2", "id": "b5f2b5f7-0336-45f7-baf1-7e11dfac50a6", "issues": [], "modified": 1557862286, "renewal_date": "2022-01-01", "status": "submitted", "version": "23be0ba3-1183-4e8e-8e9d-644527414c6e" }, "schema": { "$ref": "#/components/schemas/RenewalDecisionResult" } } }, "description": "Successful Response - Returns the edited Renewal Decision" } }, "summary": "Edit a renewal decision", "tags": [ "Renewal Decisions" ] }, "x-summary": "Edit renewal decision by id" }, "/api/v1/{group_id}/group_disconnection_requests": { "get": { "description": "Returns a list of all group Disconnection requests for a given group Id.", "operationId": "getGroupDisconnectionRequestListByGroupDeprecated", "parameters": [ { "description": "The unique identifier of the associated group in Noyo", "in": "path", "name": "group_id", "required": true, "schema": { "example": "2ce3b54a-2535-4803-b218-e6b44081d418", "format": "uuid", "type": "string" } }, { "description": "The max size of each page of results", "in": "query", "name": "page_size", "required": false, "schema": { "type": "integer" } }, { "description": "The integer offset at which to start the page. Possible values are 0 to total_records - 1", "in": "query", "name": "offset", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "example": { "meta": { "offset": 0, "page_num": 1, "page_size": 20, "total_records": 1 }, "response": [ { "carrier_id": "5200a894-81c5-4c41-8519-86c32e9a9965", "completed": null, "created": 1557329939, "decided": 1557329939, "effective_end_date": "2025-01-01", "group_id": "f833ac4b-36aa-46f4-826c-0badcfe27922", "group_name": "Widgets R Us", "id": "dd9a1813-34f7-4c7e-86bc-f041f2cbd9a1", "modified": 1557329939, "organization_id": "ca72d1e1-56a6-46ac-b400-a91e1f6b893a", "source_id": null, "source_type": "platform", "status": "processing", "version": "5200a894-81c5-4c41-8519-86c32e9a9965" } ] }, "schema": { "$ref": "#/components/schemas/PaginatedGroupDisconnectionRequestResult" } } }, "description": "Successful Response - Returns all matching Group Disconnection Requests" } }, "summary": "List Group Disconnection Request by Group (Deprecated Endpoint)", "tags": [ "GroupDisconnectionRequest" ] }, "x-summary": "Group disconnection requests by group" }, "/ping": { "get": { "description": "Returns a simple OK message with a 200 status code", "operationId": "ping", "responses": { "200": { "description": "Successful Response" } }, "security": [], "summary": "Ping Endpoint" } } }, "servers": [ { "description": "Noyo Fulfillment API - Live", "url": "https://fulfillment.noyo.com" }, { "description": "Noyo Fulfillment API - Sandbox", "url": "https://fulfillment-sandbox.noyo.com" } ], "tags": [] }