{ "openapi": "3.1.1", "info": { "title": "Kota API", "version": "1.0" }, "servers": [ { "url": "https://test.api.kota.io", "description": "Test Kota API", "x-fern-server-name": "test" }, { "url": "https://api.kota.io", "description": "Production Kota API", "x-fern-server-name": "production" } ], "paths": { "/employees/{employee_id}/associated_persons": { "post": { "tags": [ "Associated Persons" ], "summary": "Create an associated person", "description": "Creates an associated person (dependent or beneficiary) linked to an employee.", "operationId": "CreateAssociatedPerson", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAssociatedPersonRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedPersonResponse" } } } } } }, "get": { "tags": [ "Associated Persons" ], "summary": "List associated persons", "description": "Returns a list of all `associated person`'s for a specific `employee`. The `associated person`'s are returned sorted by creation date, with the most recent `associated person` appearing first.", "operationId": "ListAssociatedPersons", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedPersonResponsePagedList" } } } } } } }, "/employees/{employee_id}/associated_persons/{associated_person_id}": { "get": { "tags": [ "Associated Persons" ], "summary": "Retrieve an associated person", "description": "Retrieves an associated person object.", "operationId": "RetrieveAssociatedPerson", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "associated_person_id", "in": "path", "required": true, "schema": { "pattern": "ap_.+", "type": "string", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedPersonResponse" } } } } } }, "put": { "tags": [ "Associated Persons" ], "summary": "Update an associated person", "description": "Updates the specified associated person by setting the values of the parameters passed. Any parameters not provided will be left unchanged.", "operationId": "UpdateAssociatedPerson", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "associated_person_id", "in": "path", "required": true, "schema": { "pattern": "ap_.+", "type": "string", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAssociatedPersonRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedPersonResponse" } } } } } }, "delete": { "tags": [ "Associated Persons" ], "summary": "Delete an associated person", "description": "Permanently deletes an associated person. It cannot be undone.", "operationId": "DeleteAssociatedPerson", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "associated_person_id", "in": "path", "required": true, "schema": { "pattern": "ap_.+", "type": "string", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedPersonResponse" } } } } } } }, "/contribution_reports/{contribution_report_id}/employee_breakdowns/{employee_id}": { "get": { "tags": [ "Contribution Reports" ], "summary": "Retrieve an employee breakdown", "description": "Returns the `employee breakdown` for a `contribution report`.", "operationId": "RetrieveEmployeeBreakdownForContributionReport", "parameters": [ { "name": "contribution_report_id", "in": "path", "required": true, "schema": { "pattern": "ctr_.+", "type": "string", "example": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContributionReportEmployeeBreakdownResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/contribution_reports/{contribution_report_id}/employee_breakdowns": { "get": { "tags": [ "Contribution Reports" ], "summary": "List all employee breakdowns", "description": "Returns a list of `employee breakdowns` for a `contribution report`. The breakdowns are returned sorted by creation date, with the most recent breakdown appearing first.", "operationId": "ListEmployeeBreakdownsForContributionReport", "parameters": [ { "name": "contribution_report_id", "in": "path", "required": true, "schema": { "pattern": "ctr_.+", "type": "string", "example": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContributionReportEmployeeBreakdownResponsePagedList" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/contribution_reports/{contribution_report_id}": { "get": { "tags": [ "Contribution Reports" ], "summary": "Retrieve a contribution report", "description": "Returns a `contribution report` object.", "operationId": "RetrieveContributionReport", "parameters": [ { "name": "contribution_report_id", "in": "path", "required": true, "schema": { "pattern": "ctr_.+", "type": "string", "example": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContributionReportResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/contribution_reports": { "get": { "tags": [ "Contribution Reports" ], "summary": "List all contribution reports", "description": "Returns a list of `contribution reports`. The reports are returned sorted by creation date, with the most recent reports appearing first.", "operationId": "ListContributionReports", "parameters": [ { "name": "employer_id", "in": "query", "description": "Unique identifier of the employer for filtering reports", "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `open`, `finalized`.", "schema": { "type": "string" } }, { "name": "month", "in": "query", "description": "Month for filtering reports, used together with `year` (MM format)", "schema": { "type": "integer", "format": "int32" } }, { "name": "year", "in": "query", "description": "Year for filtering reports, can be used standalone or with `month` (YYYY format)", "schema": { "type": "integer", "format": "int32" } }, { "name": "external_customer_id", "in": "query", "description": "Unique identifier of the customer for EoR platforms, used to filter reports for a logical employer", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContributionReportResponsePagedList" } } } } } } }, "/contribution_reports/{contribution_report_id}/finalize": { "post": { "tags": [ "Contribution Reports" ], "summary": "Finalize a contribution report", "description": "This endpoint finalizes the `contribution report` object, making it immutable and preventing any further updates. Once finalized, its `status` changes to `finalized`, and it serves as a historical record for payroll reporting. Any changes or adjustments that occur after the finalization will roll into the next reporting period.", "operationId": "FinalizeContributionReport", "parameters": [ { "name": "contribution_report_id", "in": "path", "required": true, "schema": { "pattern": "ctr_.+", "type": "string", "example": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContributionReportResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/dependents_management_intents/{dependents_management_intent_id}": { "get": { "tags": [ "Dependents Management Intents" ], "summary": "Retrieve a dependents management intent", "description": "Retrieves a `dependents_management_intent` object by ID.", "operationId": "RetrieveDependentsManagementIntent", "parameters": [ { "name": "dependents_management_intent_id", "in": "path", "required": true, "schema": { "pattern": "dmi_.+", "type": "string", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsManagementIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/dependents_management_intents/{dependents_management_intent_id}/associated_persons_eligibility": { "get": { "tags": [ "Dependents Management Intents" ], "summary": "Retrieve associated persons eligibility for a dependents management intent", "description": "Retrieves all associated persons for the employee with their eligibility status for the specific policy/plan.", "operationId": "GetAssociatedPersonsEligibility", "parameters": [ { "name": "dependents_management_intent_id", "in": "path", "required": true, "schema": { "pattern": "dmi_.+", "type": "string", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedPersonEligibilityResponsePagedList" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/dependents_management_intents/{dependents_management_intent_id}/dependents": { "post": { "tags": [ "Dependents Management Intents" ], "summary": "Add dependents to a dependents management intent", "description": "Adds one or more existing associated persons as dependents to a dependents management intent.", "operationId": "AddDependentsToDependentsManagementIntent", "parameters": [ { "name": "dependents_management_intent_id", "in": "path", "required": true, "schema": { "pattern": "dmi_.+", "type": "string", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddDependentsRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsManagementIntentResponse" } } } } } } }, "/dependents_management_intents/{dependents_management_intent_id}/dependents/{associated_person_id}": { "delete": { "tags": [ "Dependents Management Intents" ], "summary": "Remove a dependent from a Dependents Management Intent", "description": "Removes a specific dependent from a Dependents Management Intent by their associated person ID. The operation returns the updated DMI state.", "operationId": "RemoveDependentFromDependentsManagementIntent", "parameters": [ { "name": "dependents_management_intent_id", "in": "path", "required": true, "schema": { "pattern": "dmi_.+", "type": "string", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "associated_person_id", "in": "path", "required": true, "schema": { "pattern": "ap_.+", "type": "string", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsManagementIntentResponse" } } } } } } }, "/dependents_management_intents/{dependents_management_intent_id}/confirm": { "post": { "tags": [ "Dependents Management Intents" ], "summary": "Confirm dependent list", "description": "Submits the finalized dependent list for processing. Call this endpoint after adding all dependents to the intent. The system validates the list and transitions the intent to `processing` status. If any dependents are marked as `ineligible` or `restricted`, they must be removed before confirmation. The parent intent's action deadline must not have passed.", "operationId": "ConfirmDependentsManagementIntent", "parameters": [ { "name": "dependents_management_intent_id", "in": "path", "required": true, "schema": { "pattern": "dmi_.+", "type": "string", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/dependents_management_intents/{dependents_management_intent_id}/cancel": { "post": { "tags": [ "Dependents Management Intents" ], "summary": "Cancel the dependents management intent", "description": "Cancels the `dependents_management_intent` in case an employee decides not to proceed with changes to their dependents. Canceling is only allowed from `action_required` status. If the intent is already `canceled`, the operation succeeds without changes. After canceling, a new dependents management intent can be created from the parent intent.", "operationId": "CancelDependentsManagementIntent", "parameters": [ { "name": "dependents_management_intent_id", "in": "path", "required": true, "schema": { "pattern": "dmi_.+", "type": "string", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/embed/sessions": { "post": { "tags": [ "Embed Sessions" ], "summary": "Get Embedded SDK token", "description": "Retrieve a `token` to authenticate an `employer` or `employee` with the Kota Embedded SDK.", "operationId": "CreateEmbedSession", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSessionTokenRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSessionTokenResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employees": { "post": { "tags": [ "Employees" ], "summary": "Create an employee", "description": "Creates an `employee` with the linked `employer`. If the `employer` has an active health insurance scheme that automatically provides insurance to employees the `employee` will be enrolled.", "operationId": "CreateEmployee", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEmployeeRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } } } }, "get": { "tags": [ "Employees" ], "summary": "List all employees", "description": "Returns a list of your `employees`. The `employees` are returned sorted by creation date, with the most recent `employees` appearing first.", "operationId": "ListEmployees", "parameters": [ { "name": "filter", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `pending`, `active`, `offboarding`, `inactive`, `restricted`.", "schema": { "type": "string" } }, { "name": "employer_id", "in": "query", "description": "Filter by employer ID.", "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "external_customer_id", "in": "query", "schema": { "type": "string" } }, { "name": "metadata_id", "in": "query", "description": "Filter by the employee's metadata \"id\" value (case-insensitive, accent-insensitive, partial match)", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/employees/{employee_id}": { "put": { "tags": [ "Employees" ], "summary": "Update an employee", "description": "Updates the specified `employee` by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the `email` parameter only the `email` value will be changed.\n\nNote that the `home_address` field is treated as single object that is updated entirely. If you provide this field, the entire address object will be replaced with the new data, not just the individual sub-fields you include in the request, potentially removing any sub-fields you didn't include in the request.\n\nThis request accepts mostly the same arguments as the `employee` creation call.", "operationId": "UpdateEmployee", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmployeeRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } }, "get": { "tags": [ "Employees" ], "summary": "Retrieve an employee", "description": "Retrieves an `employee` object.", "operationId": "RetrieveEmployee", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/employees/{employee_id}/offboard": { "post": { "tags": [ "Employees" ], "summary": "Offboard an employee", "description": "Schedules an `employee` to be offboarded. Changes affecting payroll will be reflected in the next available payroll cycle data run. Offboarding an `employee` can be cancelled up to, and including, the day before they are scheduled for offboarding. A `webhook` is available to inform you when this completes.", "operationId": "OffboardEmployee", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/OffboardEmployeeRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } } } } }, "/employees/{employee_id}/offboard/cancel": { "post": { "tags": [ "Employees" ], "summary": "Cancel offboarding an employee", "description": "Cancels the scheduled offboarding of an `employee`. Adjusts the next payroll cycle data to compensate for this change and if payroll ran while the offboarding was scheduled the next payroll cycle data will be adjusted to bring the scheme back to balance.", "operationId": "CancelOffboardingEmployee", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeResponse" } } } } } } }, "/employers": { "post": { "tags": [ "Employers" ], "summary": "Create an employer", "description": "Creates an `employer`.", "operationId": "CreateEmployer", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEmployerRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerResponse" } } } } } }, "get": { "tags": [ "Employers" ], "summary": "List all employers", "description": "Returns a list of your `employers`. The `employers` are returned sorted by creation date, with the most recent `employers` appearing first.", "operationId": "ListEmployers", "parameters": [ { "name": "filter", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `pending`, `active`, `offboarding`, `inactive`, `restricted`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employers/{employer_id}": { "put": { "tags": [ "Employers" ], "summary": "Update an employer", "description": "Updates the specified `employer` by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the `legal_address` parameter only the `legal_address` value will be changed.\n\nNote that the `legal_address` and `contact` fields are treated as single objects that are updated entirely. If you provide either of these fields, the entire object will be replaced with the new data, not just the individual sub-fields you include in the request.For instance, if you provide a partial `legal_address` object, it will overwrite the entire existing `legal_address`, potentially removing any sub-fields you didn't include in the request.\n\nThis request accepts mostly the same arguments as the `employer` creation call.", "operationId": "UpdateEmployer", "parameters": [ { "name": "employer_id", "in": "path", "required": true, "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateEmployerRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Employers" ], "summary": "Retrieve an employer", "description": "Retrieves an `employer` object.", "operationId": "RetrieveEmployer", "parameters": [ { "name": "employer_id", "in": "path", "required": true, "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employers/{employer_id}/offboard": { "post": { "tags": [ "Employers" ], "summary": "Offboard an employer", "description": "Immediately offboard an `employer`. The `employer`’s scheme will be terminated and all `employees` associated with the `employer` will be offboarded and have their insurance terminated. `Employee` offboarding cannot be cancelled if triggered via this call.", "operationId": "OffboardEmployer", "parameters": [ { "name": "employer_id", "in": "path", "required": true, "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerResponse" } } } } } } }, "/enrolment_intents": { "post": { "tags": [ "Enrolment Intents" ], "summary": "Create a new enrolment intent", "description": "Creates a new `enrolment_intent` to manage the enrolment of an employee into a group. An enrolment intent represents the intention to enrol an employee into a specific group, and tracks the status and progress of that enrolment process.", "operationId": "CreateEnrolmentIntent", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEnrolmentIntentRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Enrolment Intents" ], "summary": "List all enrolment intents", "description": "Returns a list of `enrolment_intents`. The `enrolment_intents` are returned sorted by creation date, with the most recent `enrolment_intent` appearing first.", "operationId": "ListEnrolmentIntents", "parameters": [ { "name": "employee_id", "in": "query", "description": "Filters enrolment intents by employee.", "schema": { "pattern": "ee_.+", "type": "string", "description": "Filters enrolment intents by employee.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "group_id", "in": "query", "description": "Filters enrolment intents by group.", "schema": { "pattern": "gr_.+", "type": "string", "description": "Filters enrolment intents by group.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `processing`, `scheduled`, `action_required`, `coverage_options_required`, `pending_confirmation`, `enrolling`, `enrolled`, `not_undertaken`, `ineligible`, `rejected`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/enrolment_intents/{enrolment_intent_id}": { "put": { "tags": [ "Enrolment Intents" ], "summary": "Update policy configuration enrolment intent", "description": "Updates the policy configuration for an existing `enrolment_intent`. This will reset the enrolment intent back to `processing` status and re-evaluate the enrolment intent based on the new configuration provided.Unavailable for enrolment intents that are already `enrolling` or `enrolled`.", "operationId": "UpdateEnrolmentIntentConfiguration", "parameters": [ { "name": "enrolment_intent_id", "in": "path", "required": true, "schema": { "pattern": "ei_.+", "type": "string", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/PolicyConfigurationRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Enrolment Intents" ], "summary": "Retrieve an enrolment intent", "description": "Retrieves an `enrolment_intent` object.", "operationId": "RetrieveEnrolmentIntent", "parameters": [ { "name": "enrolment_intent_id", "in": "path", "required": true, "schema": { "pattern": "ei_.+", "type": "string", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/enrolment_intents/{enrolment_intent_id}/requirements": { "get": { "tags": [ "Enrolment Intents" ], "summary": "List requirements for an enrolment intent", "description": "Returns a paginated list of adaptive requirements for an `enrolment_intent`. Requirements must be fulfilled before enrolment can proceed.", "operationId": "ListEnrolmentIntentRequirements", "parameters": [ { "name": "enrolment_intent_id", "in": "path", "required": true, "schema": { "pattern": "ei_.+", "type": "string", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "object_type", "in": "query", "description": "Filter by object type (employee or employer)", "schema": { "enum": [ "employee", "employer", "associated_person" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RequirementObjectTypeEnumParameter" } ], "description": "Filter by object type (employee or employer)" } }, { "name": "object_id", "in": "query", "description": "Filter by object ID (employee ID or employer ID)", "schema": { "type": "string", "description": "Filter by object ID (employee ID or employer ID)" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentRequirementResponsePagedList" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/enrolment_intents/{enrolment_intent_id}/confirm": { "post": { "tags": [ "Enrolment Intents" ], "summary": "Confirm an enrolment intent", "description": "Confirms an `enrolment_intent` that is in `PendingConfirmation` status. This transitions the enrolment intent to `Enrolling` status and initiates the enrolment process with the insurance provider.", "operationId": "ConfirmEnrolmentIntent", "parameters": [ { "name": "enrolment_intent_id", "in": "path", "required": true, "schema": { "pattern": "ei_.+", "type": "string", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/enrolment_intents/{enrolment_intent_id}/reject": { "post": { "tags": [ "Enrolment Intents" ], "summary": "Reject an enrolment intent", "description": "Rejects an `enrolment_intent` that is in `PendingConfirmation`, `ActionRequired`, or `CoverageOptionsRequired` status. This transitions the enrolment intent to `NotUndertaken` status.", "operationId": "RejectEnrolmentIntent", "parameters": [ { "name": "enrolment_intent_id", "in": "path", "required": true, "schema": { "pattern": "ei_.+", "type": "string", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/enrolment_intents/{enrolment_intent_id}/coverage-selections": { "post": { "tags": [ "Enrolment Intents" ], "summary": "Submit coverage selections for an enrolment intent", "description": "Submits plan coverage option selections for an enrolment intent in the `coverage_options_required` status.", "operationId": "SubmitEnrolmentIntentCoverageSelections", "parameters": [ { "name": "enrolment_intent_id", "in": "path", "required": true, "schema": { "pattern": "ei_.+", "type": "string", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SubmitCoverageSelectionsRequest" } ] } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/enrolment_intents/{enrolment_intent_id}/create_dependents_management_intent": { "post": { "tags": [ "Enrolment Intents" ], "summary": "Create a dependents management intent for an enrolment intent", "description": "Creates a dependents management intent as a sub-intent of an enrolment intent. The enrolment intent must be in `pending_confirmation` status.", "operationId": "CreateDependentsManagementIntentForEnrolmentIntent", "parameters": [ { "name": "enrolment_intent_id", "in": "path", "required": true, "schema": { "pattern": "ei_.+", "type": "string", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsManagementIntentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/events/{event_id}": { "get": { "tags": [ "Events" ], "summary": "Retrieve an event", "description": "Retrieve an `event` object. Events are available for up to 30 days.\n\nThe event’s data is rendered according to the API version at the time of its creation, as specified by the `api_version` attribute in the event object, rather than the current API version", "operationId": "RetrieveEvent", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "pattern": "evt_.+", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/events": { "get": { "tags": [ "Events" ], "summary": "List all events", "description": "Returns a list of `events` sorted by creation date, with the most recently created event appearing first. The event list includes data from up to the last 30 days.\n\nEach `event`’s data is rendered according to the API version at the time of its creation, as specified by the `api_version` attribute in the event object, rather than the current API version.", "operationId": "ListEvents", "parameters": [ { "name": "created_after", "in": "query", "description": "Filter events created after this date (limited to the last 30 days)", "schema": { "type": "string", "format": "date-time" } }, { "name": "order_direction", "in": "query", "description": "Order direction of the events list `asc` or `desc` (default: `desc`)", "schema": { "enum": [ "asc", "desc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/OrderDirectionEnumParameter" } ] } }, { "name": "version", "in": "query", "description": "API version of the events to return `v1` or `v2` (default: based on registered webhook endpoint versions)", "schema": { "enum": [ "v1", "v2" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/WebhookVersionEnumParameter" } ] } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/events/{event_id}/replay": { "post": { "tags": [ "Events" ], "summary": "Replay an event", "description": "Replays an event by creating new deliveries to all currently matching subscription endpoints. Each delivery performs a single attempt and does not trigger automatic retries.", "operationId": "ReplayEvent", "parameters": [ { "name": "event_id", "in": "path", "required": true, "schema": { "pattern": "evt_.+", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplayEventResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/group_policies": { "get": { "tags": [ "Group Policies" ], "summary": "List all group policies", "description": "Returns a list of `group_policies`. By default, only `active` and `scheduled` group policies are returned. Use the `status` query parameter to filter by other statuses. The `group_policies` are returned sorted by creation date, with the most recent `group_policy` appearing first.", "operationId": "ListGroupPolicies", "parameters": [ { "name": "employer_id", "in": "query", "description": "Filters group policies by employer.", "schema": { "pattern": "er_.+", "type": "string", "description": "Filters group policies by employer.", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "group_id", "in": "query", "description": "Filters group policies by group.", "schema": { "pattern": "gr_.+", "type": "string", "description": "Filters group policies by group.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `scheduled`, `active`, `expired`, `cancelled`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyResponsePagedList" } } } } } } }, "/group_policies/{group_policy_id}": { "get": { "tags": [ "Group Policies" ], "summary": "Retrieve a group policy", "description": "Retrieves a `group_policy` object.", "operationId": "RetrieveGroupPolicy", "parameters": [ { "name": "group_policy_id", "in": "path", "required": true, "schema": { "pattern": "gp_.+", "type": "string", "example": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/group_policy_intents": { "post": { "tags": [ "Group Policy Intents" ], "summary": "Create a group policy intent", "description": "Creates a `group_policy_intent` from a `group_quote_intent` that has a quote available. The intent coordinates the policy setup workflow including requirements collection and policy creation.", "operationId": "CreateGroupPolicyIntent", "parameters": [ { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateGroupPolicyIntentRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Group Policy Intents" ], "summary": "List group policy intents", "description": "Returns a paginated list of `group_policy_intent`'s. The results are returned sorted by creation date, with the most recent appearing first.", "operationId": "ListGroupPolicyIntents", "parameters": [ { "name": "group_id", "in": "query", "description": "Filter by group ID", "schema": { "pattern": "gr_.+", "type": "string", "description": "Filter by group ID", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "plan_id", "in": "query", "description": "Filter by plan ID", "schema": { "pattern": "pl_.+", "type": "string", "description": "Filter by plan ID", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `processing`, `action_required`, `pending_provider_approval`, `policy_created`, `expired`, `provider_rejected`, `manual_renewal_gathering_required`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentResponsePagedList" } } } } } } }, "/group_policy_intents/{group_policy_intent_id}": { "get": { "tags": [ "Group Policy Intents" ], "summary": "Retrieve a group policy intent", "description": "Retrieves a `group_policy_intent` object.", "operationId": "RetrieveGroupPolicyIntent", "parameters": [ { "name": "group_policy_intent_id", "in": "path", "required": true, "schema": { "pattern": "gpi_.+", "type": "string", "example": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/group_policy_intents/{group_policy_intent_id}/requirements": { "get": { "tags": [ "Group Policy Intents" ], "summary": "List requirements for a group policy intent", "description": "Returns a paginated list of adaptive requirements for a `group_policy_intent`. Requirements must be fulfilled before policy setup can proceed.", "operationId": "ListGroupPolicyIntentRequirements", "parameters": [ { "name": "group_policy_intent_id", "in": "path", "required": true, "schema": { "pattern": "gpi_.+", "type": "string", "example": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "object_type", "in": "query", "description": "Filter by object type (employee or employer)", "schema": { "enum": [ "employee", "employer", "associated_person" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RequirementObjectTypeEnumParameter" } ], "description": "Filter by object type (employee or employer)" } }, { "name": "object_id", "in": "query", "description": "Filter by object ID (employee ID or employer ID)", "schema": { "type": "string", "description": "Filter by object ID (employee ID or employer ID)" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentRequirementResponsePagedList" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/group_quote_intents": { "post": { "tags": [ "Group Quote Intents" ], "summary": "Create a group quote intent", "description": "Creates a `group_quote_intent` to request a quote for a `group` and `plan` combination. The intent coordinates the quote workflow including requirements collection and quote generation.", "operationId": "CreateGroupQuoteIntent", "parameters": [ { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateGroupQuoteIntentRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Group Quote Intents" ], "summary": "List group quote intents", "description": "Returns a paginated list of `group_quote_intent`'s. The results are returned sorted by creation date, with the most recent appearing first.", "operationId": "ListGroupQuoteIntents", "parameters": [ { "name": "group_id", "in": "query", "description": "Filter by group ID", "schema": { "pattern": "gr_.+", "type": "string", "description": "Filter by group ID", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "plan_id", "in": "query", "description": "Filter by plan ID", "schema": { "pattern": "pl_.+", "type": "string", "description": "Filter by plan ID", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `processing`, `action_required`, `awaiting_quote`, `quote_available`, `rejected`, `rejected_by_insurer`, `quote_expired`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentResponsePagedList" } } } } } } }, "/group_quote_intents/{group_quote_intent_id}": { "get": { "tags": [ "Group Quote Intents" ], "summary": "Retrieve a group quote intent", "description": "Retrieves a `group_quote_intent` object.", "operationId": "RetrieveGroupQuoteIntent", "parameters": [ { "name": "group_quote_intent_id", "in": "path", "required": true, "schema": { "pattern": "gqi_.+", "type": "string", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/group_quote_intents/{group_quote_intent_id}/requirements": { "get": { "tags": [ "Group Quote Intents" ], "summary": "List requirements for a group quote intent", "description": "Returns a paginated list of adaptive requirements for a `group_quote_intent`. Requirements must be fulfilled before a quote can be generated.", "operationId": "ListGroupQuoteIntentRequirements", "parameters": [ { "name": "group_quote_intent_id", "in": "path", "required": true, "schema": { "pattern": "gqi_.+", "type": "string", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "object_type", "in": "query", "description": "Filter by object type (employee or employer)", "schema": { "enum": [ "employee", "employer", "associated_person" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/RequirementObjectTypeEnumParameter" } ], "description": "Filter by object type (employee or employer)" } }, { "name": "object_id", "in": "query", "description": "Filter by object ID (employee ID or employer ID)", "schema": { "type": "string", "description": "Filter by object ID (employee ID or employer ID)" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentRequirementResponsePagedList" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/group_quote_intents/{group_quote_intent_id}/quote": { "get": { "tags": [ "Group Quote Intents" ], "summary": "Retrieve the quote for a group quote intent", "description": "Retrieves the quote details for a `group_quote_intent`. Returns pricing information and a fresh PDF URL. Only available when status is `quote_available`.", "operationId": "GetGroupQuoteIntentQuote", "parameters": [ { "name": "group_quote_intent_id", "in": "path", "required": true, "schema": { "pattern": "gqi_.+", "type": "string", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/group_quote_intents/{group_quote_intent_id}/reject": { "post": { "tags": [ "Group Quote Intents" ], "summary": "Reject a group quote intent", "description": "Rejects a `group_quote_intent` when the employer decides not to proceed with the quote. Can only reject intents in `quote_available` status.", "operationId": "RejectGroupQuoteIntent", "parameters": [ { "name": "group_quote_intent_id", "in": "path", "required": true, "schema": { "pattern": "gqi_.+", "type": "string", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/groups": { "post": { "tags": [ "Groups" ], "summary": "Create a group", "description": "Creates a `group` for the specified `employer`.", "operationId": "CreateGroup", "parameters": [ { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateGroupRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Groups" ], "summary": "List all groups", "description": "Returns a list of your `groups`. The `groups` are returned sorted by creation date, with the most recent `groups` appearing first.", "operationId": "ListGroups", "parameters": [ { "name": "employer_id", "in": "query", "description": "Filter by employer ID.", "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `pending`, `ready`, `archived`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponsePagedList" } } } } } } }, "/groups/{group_id}": { "put": { "tags": [ "Groups" ], "summary": "Update a group", "description": "Updates the specified `group`. Only `name` and `description` can be updated. Any parameters not provided will be left unchanged.", "operationId": "UpdateGroup", "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "pattern": "gr_.+", "type": "string", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateGroupRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Groups" ], "summary": "Retrieve a group", "description": "Retrieves a `group` object.", "operationId": "RetrieveGroup", "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "pattern": "gr_.+", "type": "string", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/groups/{group_id}/employees": { "get": { "tags": [ "Groups" ], "summary": "List employees in a group", "description": "Returns a list of `employees` in a `group` with their policies and enrolments. The `employees` are returned sorted by addition date, with the most recently added `employees` appearing first.", "operationId": "ListGroupEmployees", "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "pattern": "gr_.+", "type": "string", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "employee_id", "in": "query", "description": "Filter by employee ID.", "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupEmployeeResponsePagedList" } } } } } }, "post": { "tags": [ "Groups" ], "summary": "Add an employee to a group", "description": "Adds an existing employee to a `group`. The employee must belong to the same employer as the `group`. If there is a `group_policy` associated with the `group`, a corresponding `enrolment_intent` will be created for the employee.", "operationId": "AddEmployeeToGroup", "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "pattern": "gr_.+", "type": "string", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AddEmployeeToGroupRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupEmployeeResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/groups/{group_id}/eligibility_check": { "post": { "tags": [ "Groups" ], "summary": "Check employee eligibility for a group", "description": "Checks whether an `employee` qualifies for a `group` without adding them to it. This is a dry-run eligibility check — the employee is not enrolled or added. The response includes provider and plan information.", "operationId": "CheckGroupEligibility", "parameters": [ { "name": "group_id", "in": "path", "required": true, "schema": { "pattern": "gr_.+", "type": "string", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CheckGroupEligibilityRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EligibilityCheckResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employers/{employer_id}/health_insurance/quotes/{employer_quote_id}": { "get": { "tags": [ "Health Insurance" ], "summary": "Retrieve employer quote", "description": "Returns group's health insurance `quote` for an `employer` by `employer_quote_id`.", "operationId": "RetrieveEmployerHealthInsuranceQuote", "parameters": [ { "name": "employer_id", "in": "path", "required": true, "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "employer_quote_id", "in": "path", "required": true, "schema": { "pattern": "erhq_.+", "type": "string", "example": "erhq_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employers/{employer_id}/health_insurance/quotes": { "get": { "tags": [ "Health Insurance" ], "summary": "List all employer quotes", "description": "Returns a list of health insurance `quotes` for an `employer`. The `quotes` are returned sorted by creation date, with the most recent `quote` appearing first.", "operationId": "ListEmployerHealthInsuranceQuotes", "parameters": [ { "name": "employer_id", "in": "path", "required": true, "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `pending_quote`, `action_required`, `not_undertaken`, `accepted`, `pending_insurer_acceptance`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponsePagedList" } } } } } } }, "/employers/{employer_id}/health_insurance/policies/{employer_policy_id}": { "get": { "tags": [ "Health Insurance" ], "summary": "Retrieve an employer policy", "description": "Retrieve group's health insurance `policy` for an `employer` by `employer_policy_id`.", "operationId": "RetrieveEmployerHealthInsurancePolicy", "parameters": [ { "name": "employer_id", "in": "path", "required": true, "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "employer_policy_id", "in": "path", "required": true, "schema": { "pattern": "erhp_.+", "type": "string", "example": "erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsurancePolicyResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employers/{employer_id}/health_insurance/policies": { "get": { "tags": [ "Health Insurance" ], "summary": "List all employer policies", "description": "Returns a list of group health insurance `policies` for an `employer`. The `policies` are returned sorted by creation date, with the most recent `policy` appearing first.", "operationId": "ListEmployerHealthInsurancePolicies", "parameters": [ { "name": "employer_id", "in": "path", "required": true, "schema": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `scheduled`, `active`, `expired`, `cancelled`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsurancePolicyResponsePagedList" } } } } } } }, "/employees/{employee_id}/health_insurance/offers/{employee_offer_id}": { "get": { "tags": [ "Health Insurance" ], "summary": "Retrieve an employee offer", "description": "Retrieve group's health insurance `offer` for an `employee` by `employee_offer_id`.", "operationId": "RetrieveEmployeeHealthInsuranceOffer", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "employee_offer_id", "in": "path", "required": true, "schema": { "pattern": "eeho_.+", "type": "string", "example": "eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsuranceOfferResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employees/{employee_id}/health_insurance/offers": { "get": { "tags": [ "Health Insurance" ], "summary": "List all employee offers", "description": "Returns a list of group health insurance `offers` for an `employee`. The `offers` are returned sorted by creation date, with the most recent `offer` appearing first.", "operationId": "ListEmployeeHealthInsuranceOffers", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsuranceOfferResponsePagedList" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employees/{employee_id}/health_insurance/policies": { "get": { "tags": [ "Health Insurance" ], "summary": "List all employee policies", "description": "Returns a list of group health insurance `policies` for an `employee`. The `policies` are returned sorted by creation date, with the most recent `policy` appearing first.", "operationId": "ListEmployeeHealthInsurancePolicies", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `scheduled`, `active`, `expired`, `cancelled`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyResponsePagedList" } } } } } } }, "/employees/{employee_id}/health_insurance/policies/{employee_policy_id}": { "get": { "tags": [ "Health Insurance" ], "summary": "Retrieve an employee policy", "description": "Retrieve group's health insurance `policy` for an `employee` by `employee_policy_id`.", "operationId": "RetrieveEmployeeHealthInsurancePolicy", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "employee_policy_id", "in": "path", "required": true, "schema": { "pattern": "eehp_.+", "type": "string", "example": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/hosted/sessions": { "post": { "tags": [ "Hosted Sessions" ], "summary": "Get One-off Hosted Session Link", "description": "Retrieve a hosted `link` to authenticate an `employee` with the Kota Hosted. This link is valid for a single use and expires after 60 minutes.", "operationId": "CreateHostedSession", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSessionTokenLinkRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateHostedSessionTokenResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/plans": { "get": { "tags": [ "Plans" ], "summary": "List all plans", "description": "Returns a list of `plans`.", "operationId": "ListPlans", "parameters": [ { "name": "type", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `health_insurance`.", "schema": { "type": "string" } }, { "name": "provider_id", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `pr_allianz`, `pr_irishlifehealth`, `pr_vitality`, `pr_onvz`, `pr_freedom`, `pr_sanitas`, `pr_canadalife`, `pr_hallesche`, `pr_bupa`, `pr_dansksundhedssikring`, `pr_allianzkpt`, `pr_freedomuk`, `pr_bupaglobal`, `pr_expatriate`.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Filters plans by country.", "schema": { "enum": [ "af", "ax", "al", "dz", "as", "ad", "ao", "ai", "aq", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "bq", "ba", "bw", "bv", "br", "io", "bn", "bg", "bf", "bi", "cv", "kh", "cm", "ca", "ky", "cf", "td", "cl", "cn", "cx", "cc", "co", "km", "cg", "cd", "ck", "cr", "ci", "hr", "cu", "cw", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "sz", "et", "fk", "fo", "fj", "fi", "fr", "gf", "pf", "tf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gg", "gn", "gw", "gy", "ht", "hm", "va", "hn", "hk", "hu", "is", "in", "id", "ir", "iq", "ie", "im", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kp", "kr", "xk", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mo", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nc", "nz", "ni", "ne", "ng", "nu", "nf", "mk", "mp", "no", "om", "pk", "pw", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "re", "ro", "ru", "rw", "bl", "sh", "kn", "lc", "mf", "pm", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sx", "sk", "si", "sb", "so", "za", "gs", "ss", "es", "lk", "sd", "sr", "sj", "se", "ch", "sy", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "tc", "tv", "ug", "ua", "ae", "gb", "um", "us", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "wf", "eh", "ye", "zm", "zw" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CountryCodeEnumParameter" } ], "description": "Filters plans by country." } }, { "name": "available_on", "in": "query", "description": "Filters plans available on a specific date. Defaults to today.", "schema": { "type": "string", "description": "Filters plans available on a specific date. Defaults to today.", "format": "date" } }, { "name": "group_id", "in": "query", "description": "Filters plans by group eligibility. Only plans whose eligibility criteria match the group are returned. Criteria that cannot be evaluated are ignored.", "schema": { "pattern": "gr_.+", "type": "string", "description": "Filters plans by group eligibility. Only plans whose eligibility criteria match the group are returned. Criteria that cannot be evaluated are ignored.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "start_date", "in": "query", "description": "Reference date used to compute employee age when evaluating per-plan eligibility counts. Required together with `group_id` for counts to be included in the response.", "schema": { "type": "string", "description": "Reference date used to compute employee age when evaluating per-plan eligibility counts. Required together with `group_id` for counts to be included in the response.", "format": "date" } }, { "name": "sort_by", "in": "query", "description": "Sorts plans by a specific field. Currently only `premium` is supported.", "schema": { "enum": [ "premium" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/PlanSortByEnumParameter" } ], "description": "Sorts plans by a specific field. Currently only `premium` is supported." } }, { "name": "sort_dir", "in": "query", "description": "Sort direction. Defaults to `asc` (ascending).", "schema": { "enum": [ "asc", "desc" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/SortDirectionEnumParameter" } ], "description": "Sort direction. Defaults to `asc` (ascending)." } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/plans/{plan_id}": { "get": { "tags": [ "Plans" ], "summary": "Retrieve a plan", "description": "Retrieves a `plan` object by its ID.", "operationId": "RetrievePlan", "parameters": [ { "name": "plan_id", "in": "path", "required": true, "schema": { "pattern": "pl_.+", "type": "string", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "group_id", "in": "query", "description": "When provided together with `start_date`, per-plan eligibility counts are included in the response. Silently ignored if not paired with `start_date`.", "schema": { "pattern": "gr_.+", "type": "string", "description": "When provided together with `start_date`, per-plan eligibility counts are included in the response. Silently ignored if not paired with `start_date`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "start_date", "in": "query", "description": "Reference date used to compute employee age when evaluating eligibility. Required together with `group_id` for counts to be included.", "schema": { "type": "string", "description": "Reference date used to compute employee age when evaluating eligibility. Required together with `group_id` for counts to be included.", "format": "date" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/policies": { "get": { "tags": [ "Policies" ], "summary": "List all policies", "description": "Returns a list of `policies`. By default, only `active` and `scheduled` policies are returned. Use the `status` query parameter to filter by other statuses. The `policies` are returned sorted by creation date, with the most recent `policy` appearing first.", "operationId": "ListPolicies", "parameters": [ { "name": "employee_id", "in": "query", "description": "Filters policies by employee.", "schema": { "pattern": "ee_.+", "type": "string", "description": "Filters policies by employee.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "group_id", "in": "query", "description": "Filters policies by group.", "schema": { "pattern": "gr_.+", "type": "string", "description": "Filters policies by group.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "group_policy_id", "in": "query", "description": "Filters policies by group policy.", "schema": { "pattern": "gp_.+", "type": "string", "description": "Filters policies by group policy.", "example": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `scheduled`, `active`, `expired`, `cancelled`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyResponsePagedList" } } } } } } }, "/policies/{policy_id}": { "get": { "tags": [ "Policies" ], "summary": "Retrieve a policy", "description": "Retrieves a `policy` object.", "operationId": "RetrievePolicy", "parameters": [ { "name": "policy_id", "in": "path", "required": true, "schema": { "pattern": "p_.+", "type": "string", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/policies/{policy_id}/policy_amendment_intents": { "get": { "tags": [ "Policy Amendment Intents" ], "summary": "List all policy amendment intents for a policy", "description": "Returns a paginated list of policy amendment intents for the specified policy. The intents are returned sorted by creation date, with the oldest intent appearing first.", "operationId": "ListPolicyAmendmentIntents", "parameters": [ { "name": "policy_id", "in": "path", "required": true, "schema": { "pattern": "p_.+", "type": "string", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `action_required`, `awaiting_quote`, `pending_confirmation`, `processing`, `amended`, `processing_error`, `not_undertaken`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Policy Amendment Intents" ], "summary": "Create a new policy amendment intent", "description": "Initiates a policy amendment (e.g. adding/removing dependents). The intent coordinates the amendment workflow including dependents sub-intent management, quote generation, employee confirmation, and provider processing.", "operationId": "CreatePolicyAmendmentIntent", "parameters": [ { "name": "policy_id", "in": "path", "required": true, "schema": { "pattern": "p_.+", "type": "string", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreatePolicyAmendmentIntentRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/policies/{policy_id}/policy_amendment_intents/{policy_amendment_intent_id}": { "get": { "tags": [ "Policy Amendment Intents" ], "summary": "Retrieve a policy amendment intent", "description": "Retrieves a `policy_amendment_intent` object.", "operationId": "RetrievePolicyAmendmentIntent", "parameters": [ { "name": "policy_id", "in": "path", "required": true, "schema": { "pattern": "p_.+", "type": "string", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "policy_amendment_intent_id", "in": "path", "required": true, "schema": { "pattern": "pai_.+", "type": "string", "example": "pai_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/policies/{policy_id}/policy_amendment_intents/{policy_amendment_intent_id}/confirm": { "post": { "tags": [ "Policy Amendment Intents" ], "summary": "Confirm policy amendment intent", "description": "Confirms a policy amendment intent after the employee has reviewed and accepted the quote. The intent must be in `pending_confirmation` status with a valid quote. The confirmation deadline must not have passed.", "operationId": "ConfirmPolicyAmendmentIntent", "parameters": [ { "name": "policy_id", "in": "path", "required": true, "schema": { "pattern": "p_.+", "type": "string", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "policy_amendment_intent_id", "in": "path", "required": true, "schema": { "pattern": "pai_.+", "type": "string", "example": "pai_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/policies/{policy_id}/policy_amendment_intents/{id}/cancel": { "post": { "tags": [ "Policy Amendment Intents" ], "summary": "Cancel a policy amendment intent", "description": "Cancels a policy amendment intent when the employee decides not to proceed. Can only cancel intents in `action_required` or `pending_confirmation` status.", "operationId": "CancelPolicyAmendmentIntent", "parameters": [ { "name": "policy_id", "in": "path", "required": true, "schema": { "pattern": "p_.+", "type": "string", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "id", "in": "path", "required": true, "schema": { "pattern": "pai_.+", "type": "string", "example": "pai_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/policies/{policy_id}/policy_amendment_intents/{id}/create_dependents_management_intent": { "post": { "tags": [ "Policy Amendment Intents" ], "summary": "Create a dependents management intent for a policy amendment", "description": "Creates a dependents management intent as a sub-intent of a policy amendment intent. The sub-intent allows the platform to add or remove dependents from the policy. The policy amendment intent must be in `action_required` status with a `dependents` requested change.", "operationId": "CreateDependentsManagementIntentForPolicyAmendment", "parameters": [ { "name": "policy_id", "in": "path", "required": true, "schema": { "pattern": "p_.+", "type": "string", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "id", "in": "path", "required": true, "schema": { "pattern": "pai_.+", "type": "string", "example": "pai_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsManagementIntentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/policy_import_intents": { "post": { "tags": [ "Policy Import Intents" ], "summary": "Create a new policy import intent", "description": "Initiates a policy import process for an employee with an existing policy created outside of Kota's systems. This endpoint allows importing policy details for an employee who has an existing policy with one of our existing providers.", "operationId": "CreatePolicyImportIntent", "parameters": [ { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreatePolicyImportIntentRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyImportIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "get": { "tags": [ "Policy Import Intents" ], "summary": "List all policy import intents", "description": "Returns a paginated list of policy import intents. The intents are returned sorted by creation date, with the most recent intent appearing first. Results can be filtered by employee ID, group ID, and status.", "operationId": "ListPolicyImportIntents", "parameters": [ { "name": "employee_id", "in": "query", "description": "Filters policy import intents by employee ID. Prefixed with `ee_`.", "schema": { "pattern": "ee_.+", "type": "string", "description": "Filters policy import intents by employee ID. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "group_id", "in": "query", "description": "Filters policy import intents by group ID. Prefixed with `g_`.", "schema": { "pattern": "gr_.+", "type": "string", "description": "Filters policy import intents by group ID. Prefixed with `g_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "status", "in": "query", "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `processing`, `failed`, `success`.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyImportIntentResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/policy_import_intents/{policy_import_intent_id}": { "get": { "tags": [ "Policy Import Intents" ], "summary": "Retrieve a policy import intent", "description": "Retrieves a `policy_import_intent` object.", "operationId": "RetrievePolicyImportIntent", "parameters": [ { "name": "policy_import_intent_id", "in": "path", "required": true, "schema": { "pattern": "pii_.+", "type": "string", "example": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyImportIntentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/providers": { "get": { "tags": [ "Providers" ], "summary": "List all providers", "description": "Returns a list of `providers`.", "operationId": "ListProviders", "parameters": [ { "name": "country", "in": "query", "description": "Filter by country; only providers that support this country are returned.", "schema": { "enum": [ "af", "ax", "al", "dz", "as", "ad", "ao", "ai", "aq", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "bq", "ba", "bw", "bv", "br", "io", "bn", "bg", "bf", "bi", "cv", "kh", "cm", "ca", "ky", "cf", "td", "cl", "cn", "cx", "cc", "co", "km", "cg", "cd", "ck", "cr", "ci", "hr", "cu", "cw", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "sz", "et", "fk", "fo", "fj", "fi", "fr", "gf", "pf", "tf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gg", "gn", "gw", "gy", "ht", "hm", "va", "hn", "hk", "hu", "is", "in", "id", "ir", "iq", "ie", "im", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kp", "kr", "xk", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mo", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nc", "nz", "ni", "ne", "ng", "nu", "nf", "mk", "mp", "no", "om", "pk", "pw", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "re", "ro", "ru", "rw", "bl", "sh", "kn", "lc", "mf", "pm", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sx", "sk", "si", "sb", "so", "za", "gs", "ss", "es", "lk", "sd", "sr", "sj", "se", "ch", "sy", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "tc", "tv", "ug", "ua", "ae", "gb", "um", "us", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "wf", "eh", "ye", "zm", "zw" ], "type": "string", "allOf": [ { "$ref": "#/components/schemas/CountryCodeEnumParameter" } ], "description": "Filter by country; only providers that support this country are returned." } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/providers/{provider_id}": { "get": { "tags": [ "Providers" ], "summary": "Retrieve a provider", "description": "Retrieves a `provider` object by its ID.", "operationId": "RetrieveProvider", "parameters": [ { "name": "provider_id", "in": "path", "required": true, "schema": { "pattern": "pr_.+", "type": "string", "example": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/employees/{employee_id}/salaries": { "post": { "tags": [ "Salaries" ], "summary": "Create a salary record", "description": "Creates a new `salary` record for an `employee`, effective from the given date. Salary records are immutable — to change an employee's salary, create a new record with a later `effective_from` date rather than modifying an existing one.", "operationId": "CreateSalary", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "Idempotency-Key", "in": "header", "description": "Unique key to ensure idempotent requests. If the same key is used for multiple _identical & successful_ requests, the same response will be returned. [Read more here](/api#idempotent-requests)", "schema": { "type": "string" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateSalaryRequest" } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalaryResponse" } } } } } }, "get": { "tags": [ "Salaries" ], "summary": "List salary records", "description": "Returns a list of all `salary` records for a specific `employee`, sorted by `effective_from` descending (most recent first).", "operationId": "ListSalaries", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalaryResponsePagedList" } } } } } } }, "/employees/{employee_id}/salaries/{salary_id}": { "delete": { "tags": [ "Salaries" ], "summary": "Delete a salary record", "description": "Deletes a `salary` record — for example one submitted in error, against the wrong employee, or a duplicate. A deleted record no longer appears in the employee's salary list and is no longer eligible to be their current salary; if it was the current record, the next most recent one takes its place.", "operationId": "DeleteSalary", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "salary_id", "in": "path", "required": true, "schema": { "pattern": "sal_.+", "type": "string", "example": "sal_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalaryResponse" } } } } } }, "get": { "tags": [ "Salaries" ], "summary": "Retrieve a salary record", "description": "Retrieves a `salary` object.", "operationId": "RetrieveSalary", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "salary_id", "in": "path", "required": true, "schema": { "pattern": "sal_.+", "type": "string", "example": "sal_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalaryResponse" } } } } } } }, "/employees/{employee_id}/salaries/current": { "get": { "tags": [ "Salaries" ], "summary": "Retrieve the current salary record", "description": "Retrieves the `salary` record currently in effect for an `employee` — the one with the latest `effective_from` date on or before today.", "operationId": "RetrieveCurrentSalary", "parameters": [ { "name": "employee_id", "in": "path", "required": true, "schema": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalaryResponse" } } } } } } }, "/webhooks/endpoints/{webhook_endpoint_id}": { "get": { "tags": [ "Webhooks" ], "summary": "Retrieve a webhook endpoint", "description": "Get a registered webhook endpoint by its Id.", "operationId": "RetrieveWebhookEndpoint", "parameters": [ { "name": "webhook_endpoint_id", "in": "path", "required": true, "schema": { "pattern": "whe_.+", "type": "string", "example": "whe_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/webhooks/endpoints": { "get": { "tags": [ "Webhooks" ], "summary": "List all webhook endpoints", "description": "Get all registered webhook endpoints for the platform.", "operationId": "ListWebhookEndpoints", "parameters": [ { "name": "page", "in": "query", "description": "The page of results to return. Defaults to 1 if not provided.", "schema": { "type": "integer", "description": "The page of results to return. Defaults to 1 if not provided.", "format": "int32" } }, { "name": "page_size", "in": "query", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "schema": { "type": "integer", "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "format": "int32" } }, { "name": "X-Platform-Id", "in": "header", "description": "The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponsePagedList" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } } }, "components": { "schemas": { "AddDependentsRequest": { "required": [ "associated_person_ids" ], "type": "object", "properties": { "associated_person_ids": { "type": "array", "items": { "pattern": "ap_.+", "type": "string", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "description": "List of associated person IDs to add as dependents. Must not be empty." }, "dependent_coverage_selections": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DependentCoverageSelectionsRequest" }, "description": "Optional coverage selections per dependent. Keyed by associated person ID." } }, "additionalProperties": false }, "AddEmployeeToGroupRequest": { "required": [ "employee_id" ], "type": "object", "properties": { "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Employee Id", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "create_enrolment_intents": { "type": [ "null", "boolean" ], "description": "Controls whether enrolment intents are automatically created for the employee. Defaults to `true` for hosted platforms. When `true` on a hosted platform, the response includes an `enrolment_intent_id`. For non-hosted platforms, the `enrolment_intent_id` is not included in the response, subscribe to the `enrolment_intent.processing` webhook to be notified when the enrolment intent is created." }, "policy_configuration": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyConfigurationRequest" } ], "description": "Policy configuration for the employee in this group. Leave null to use `group` defaults." } }, "additionalProperties": false }, "AddressModel": { "required": [ "city", "country_code", "line1", "postal_code" ], "type": "object", "properties": { "line1": { "type": "string", "description": "Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "line2": { "type": [ "null", "string" ], "description": "NOTE: This field will be normalized according to our internal formatting rules." }, "line3": { "type": [ "null", "string" ], "description": "NOTE: This field will be normalized according to our internal formatting rules." }, "city": { "type": "string", "description": "Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "state": { "type": [ "null", "string" ], "description": "Required for United States (State), and Canada (Province). NOTE: This field will be normalized according to our internal formatting rules." }, "postal_code": { "type": "string", "description": "Must not be empty, and a valid postal code for the specified country. NOTE: This field will be normalized according to our internal formatting rules." }, "country_code": { "allOf": [ { "$ref": "#/components/schemas/CountryCode" } ] } }, "additionalProperties": false }, "AddressModelWithoutCountry": { "required": [ "city", "line1", "postal_code" ], "type": "object", "properties": { "line1": { "type": "string", "description": "Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "line2": { "type": [ "null", "string" ], "description": "NOTE: This field will be normalized according to our internal formatting rules." }, "line3": { "type": [ "null", "string" ], "description": "NOTE: This field will be normalized according to our internal formatting rules." }, "city": { "type": "string", "description": "Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "state": { "type": [ "null", "string" ], "description": "Required for United States (State), and Canada (Province). NOTE: This field will be normalized according to our internal formatting rules." }, "postal_code": { "type": "string", "description": "Must not be empty, and a valid postal code for the specified country. NOTE: This field will be normalized according to our internal formatting rules." } }, "additionalProperties": false }, "AgeRangeDetails": { "type": "object", "properties": { "min": { "type": [ "null", "integer" ], "description": "Minimum age required.", "format": "int32" }, "max": { "type": [ "null", "integer" ], "description": "Maximum age allowed.", "format": "int32" } }, "additionalProperties": false }, "AmendmentReasonType": { "enum": [ "initial_adjustment_period", "qualifying_life_event" ], "type": "string", "x-fern-enum": { "initial_adjustment_period": { "description": "Amendment during the initial adjustment period after policy activation." }, "qualifying_life_event": { "description": "Amendment due to a qualifying life event (e.g., marriage, birth of a child)." } } }, "AssociatedPersonEligibilityResponse": { "required": [ "associated_person_id", "date_of_birth", "eligibility_status", "first_name", "last_name", "relationship", "sex_at_birth" ], "type": "object", "properties": { "associated_person_id": { "pattern": "ap_.+", "type": "string", "description": "The associated person ID. Prefixed with `ap_`.", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "first_name": { "type": "string", "description": "First name of the associated person." }, "last_name": { "type": "string", "description": "Last name of the associated person." }, "date_of_birth": { "type": "string", "description": "Date of birth of the associated person.", "format": "date", "example": "2024-12-01" }, "sex_at_birth": { "allOf": [ { "$ref": "#/components/schemas/SexAtBirth" } ], "description": "Sex at birth of the associated person." }, "relationship": { "allOf": [ { "$ref": "#/components/schemas/RelationshipType" } ], "description": "Relationship type to the employee." }, "eligibility_status": { "allOf": [ { "$ref": "#/components/schemas/EligibilityStatus" } ], "description": "Eligibility status for the policy/plan." }, "ineligibility_reason": { "type": [ "null", "string" ], "description": "Reason for ineligibility if status is ineligible." }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "AssociatedPersonEligibilityResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedPersonEligibilityResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "AssociatedPersonEventResponse": { "required": [ "employee_id", "id" ], "type": "object", "properties": { "id": { "pattern": "ap_.+", "type": "string", "description": "Unique identifier for the associated person", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee this person is associated with", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "AssociatedPersonResponse": { "required": [ "date_of_birth", "employee_id", "first_name", "id", "last_name", "relationship_type", "sex_at_birth" ], "type": "object", "properties": { "id": { "pattern": "ap_.+", "type": "string", "description": "Unique identifier for the associated person", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "platform_id": { "pattern": "pt_.+", "type": "string", "description": "Unique identifier for the platform", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee this person is associated with", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "first_name": { "type": "string", "description": "First name of the associated person" }, "last_name": { "type": "string", "description": "Last name of the associated person" }, "date_of_birth": { "type": "string", "description": "Date of birth of the associated person", "format": "date", "example": "2024-12-01" }, "sex_at_birth": { "allOf": [ { "$ref": "#/components/schemas/SexAtBirth" } ], "description": "The sex assigned to the associated person at birth" }, "relationship_type": { "allOf": [ { "$ref": "#/components/schemas/RelationshipType" } ], "description": "The relationship type between the employee and the associated person" }, "email": { "type": [ "null", "string" ], "description": "Email address of the associated person" }, "phone_number": { "type": [ "null", "string" ], "description": "Phone number in E.164 international format (e.g. +447700900999)" }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "AssociatedPersonResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AssociatedPersonResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "AssociatedPersonType": { "enum": [ "dependents" ], "type": "string", "x-fern-enum": { "dependents": { "description": "Dependents (e.g., spouse, children)." } } }, "AssociatedPersonUpdatedV2Webhook": { "title": "AssociatedPersonUpdatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "associated_person.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/AssociatedPersonEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "BenefitType": { "enum": [ "health_insurance" ], "type": "string" }, "BenefitTypeMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/BenefitType" } } }, "additionalProperties": false }, "BundlingType": { "enum": [ "not_bundled", "bundled_primary", "bundled_secondary" ], "type": "string" }, "CheckGroupEligibilityRequest": { "required": [ "employee_id" ], "type": "object", "properties": { "employee_id": { "pattern": "ee_.+", "type": "string", "description": "The employee to check eligibility for.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "ConsentApprovalInput": { "required": [ "ip", "type", "user_id", "version" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/ConsentType" } ], "description": "Type of consent being approved" }, "ip": { "type": "string", "description": "IP address of the user approving" }, "version": { "type": "string", "description": "Version of the consent document being approved" }, "user_id": { "type": "string", "description": "User ID approving the consent" } }, "additionalProperties": false }, "ConsentLinkResponse": { "required": [ "type", "url", "version" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/ConsentType" } ], "description": "Type of consent" }, "url": { "type": "string", "description": "URL to the consent document" }, "version": { "type": "string", "description": "Version of the consent document" } }, "additionalProperties": false }, "ConsentType": { "enum": [ "terms_of_business", "privacy_policy" ], "type": "string" }, "ContactModel": { "required": [ "email", "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Contact person name. NOTE: This field will be normalized according to our internal formatting rules." }, "email": { "type": "string", "description": "Contact email address. NOTE: This field will be normalized according to our internal formatting rules." } }, "additionalProperties": false }, "ContributionReportEmployeeBreakdownResponse": { "required": [ "contribution_report_id", "created_at", "currency", "employee_id", "employer_id", "health_insurance", "last_updated_at", "period", "status" ], "type": "object", "properties": { "object": { "type": "string", "description": "The object type", "readOnly": true }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier of the employee for which the breakdown is created", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "contribution_report_id": { "pattern": "ctr_.+", "type": "string", "description": "Unique identifier of the related contribution report", "example": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Unique identifier of the employer for which the breakdown is created", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "Unique identifier of the customer for which the breakdown is created. This identifier is assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This parameter is only available to EoR platforms." }, "period": { "allOf": [ { "$ref": "#/components/schemas/GetEmployeeBreakdownPeriod" } ], "description": "Period covered by the employee breakdown" }, "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "The currency in which all the amounts in this breakdown are presented (e.g. `eur`)" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ContributionReportStatus" } ], "description": "Current status of the breakdown" }, "finalized_at": { "type": [ "null", "string" ], "description": "Date and time the breakdown was finalized, if applicable", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "created_at": { "type": "string", "description": "Date and time the breakdown was created", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "last_updated_at": { "type": "string", "description": "Date and time of the last update to the breakdown", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "health_insurance": { "allOf": [ { "$ref": "#/components/schemas/GetEmployeeBreakdownHealthInsurance" } ], "description": "Health insurance contribution details" } }, "additionalProperties": false }, "ContributionReportEmployeeBreakdownResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContributionReportEmployeeBreakdownResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "ContributionReportEventResponse": { "required": [ "employer_id", "id" ], "type": "object", "properties": { "id": { "pattern": "ctr_.+", "type": "string", "description": "Unique identifier for the contribution report", "example": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Unique identifier of the employer for which the report is created", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "Unique identifier of the customer for which the report is created. This identifier is assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This parameter is only available to EoR platforms." }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "ContributionReportFinalizedV2Webhook": { "title": "ContributionReportFinalizedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "contribution_report.finalized" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/ContributionReportEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "ContributionReportFinalizedWebhook": { "title": "ContributionReportFinalizedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "contribution_report.finalized" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/ContributionReportResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "ContributionReportResponse": { "required": [ "created_at", "employer_id", "id", "last_updated_at", "period", "status" ], "type": "object", "properties": { "object": { "type": "string", "description": "The object type", "readOnly": true }, "id": { "pattern": "ctr_.+", "type": "string", "description": "Unique identifier for the contribution report", "example": "ctr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Unique identifier of the employer for which the report is created", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "Unique identifier of the customer for which the report is created. This identifier is assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This parameter is only available to EoR platforms." }, "period": { "allOf": [ { "$ref": "#/components/schemas/GetContributionReportPeriod" } ], "description": "Period covered by the contribution report" }, "status": { "allOf": [ { "$ref": "#/components/schemas/ContributionReportStatus" } ], "description": "Current status of the contribution report" }, "finalized_at": { "type": [ "null", "string" ], "description": "Date and time the report was finalized, if applicable", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "file_id": { "pattern": "file_.+", "type": [ "null", "string" ], "description": "Identifier of the report's downloadable CSV file. The file is prepared shortly after the report is finalized, so this is null while the report is open and for a short while after it is finalized — re-fetch the report until it appears. Exchange it for a download link via `GET /files/{file_id}/download_link`.", "example": "file_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "created_at": { "type": "string", "description": "Date and time the report was created", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "last_updated_at": { "type": "string", "description": "Date and time of the last update to the report", "format": "date-time", "example": "2024-12-01T00:00:00Z" } }, "additionalProperties": false }, "ContributionReportResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ContributionReportResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "ContributionReportStatus": { "enum": [ "open", "finalized" ], "type": "string" }, "ContributionReportStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/ContributionReportStatus" } } }, "additionalProperties": false }, "CostSharingOption": { "enum": [ "percentage", "fixed_amount", "member_count", "policyholder_only", "member_selection", "member_selection_percentage_based", "family_type", "full_coverage" ], "type": "string", "x-fern-enum": { "percentage": { "description": "A percentage of the total premium is covered." }, "fixed_amount": { "description": "Up to a fixed amount is covered." }, "member_count": { "description": "The number of additional adults and children to cover is specified." }, "policyholder_only": { "description": "Only the policyholder is covered." }, "member_selection": { "description": "Dependent categories to cover are selected (partner and/or children)." }, "member_selection_percentage_based": { "description": "Dependent categories to cover are selected, each covered at a percentage of their premium." }, "family_type": { "description": "Coverage is based on a predefined family tier (e.g. Single, Couple, Family)." }, "full_coverage": { "description": "The premium is fully covered." } } }, "CountryCode": { "enum": [ "af", "ax", "al", "dz", "as", "ad", "ao", "ai", "aq", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "bq", "ba", "bw", "bv", "br", "io", "bn", "bg", "bf", "bi", "cv", "kh", "cm", "ca", "ky", "cf", "td", "cl", "cn", "cx", "cc", "co", "km", "cg", "cd", "ck", "cr", "ci", "hr", "cu", "cw", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "sz", "et", "fk", "fo", "fj", "fi", "fr", "gf", "pf", "tf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gg", "gn", "gw", "gy", "ht", "hm", "va", "hn", "hk", "hu", "is", "in", "id", "ir", "iq", "ie", "im", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kp", "kr", "xk", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mo", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nc", "nz", "ni", "ne", "ng", "nu", "nf", "mk", "mp", "no", "om", "pk", "pw", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "re", "ro", "ru", "rw", "bl", "sh", "kn", "lc", "mf", "pm", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sx", "sk", "si", "sb", "so", "za", "gs", "ss", "es", "lk", "sd", "sr", "sj", "se", "ch", "sy", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "tc", "tv", "ug", "ua", "ae", "gb", "um", "us", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "wf", "eh", "ye", "zm", "zw" ], "type": "string" }, "CountryCodeEnumParameter": { "enum": [ "af", "ax", "al", "dz", "as", "ad", "ao", "ai", "aq", "ag", "ar", "am", "aw", "au", "at", "az", "bs", "bh", "bd", "bb", "by", "be", "bz", "bj", "bm", "bt", "bo", "bq", "ba", "bw", "bv", "br", "io", "bn", "bg", "bf", "bi", "cv", "kh", "cm", "ca", "ky", "cf", "td", "cl", "cn", "cx", "cc", "co", "km", "cg", "cd", "ck", "cr", "ci", "hr", "cu", "cw", "cy", "cz", "dk", "dj", "dm", "do", "ec", "eg", "sv", "gq", "er", "ee", "sz", "et", "fk", "fo", "fj", "fi", "fr", "gf", "pf", "tf", "ga", "gm", "ge", "de", "gh", "gi", "gr", "gl", "gd", "gp", "gu", "gt", "gg", "gn", "gw", "gy", "ht", "hm", "va", "hn", "hk", "hu", "is", "in", "id", "ir", "iq", "ie", "im", "il", "it", "jm", "jp", "je", "jo", "kz", "ke", "ki", "kp", "kr", "xk", "kw", "kg", "la", "lv", "lb", "ls", "lr", "ly", "li", "lt", "lu", "mo", "mg", "mw", "my", "mv", "ml", "mt", "mh", "mq", "mr", "mu", "yt", "mx", "fm", "md", "mc", "mn", "me", "ms", "ma", "mz", "mm", "na", "nr", "np", "nl", "nc", "nz", "ni", "ne", "ng", "nu", "nf", "mk", "mp", "no", "om", "pk", "pw", "ps", "pa", "pg", "py", "pe", "ph", "pn", "pl", "pt", "pr", "qa", "re", "ro", "ru", "rw", "bl", "sh", "kn", "lc", "mf", "pm", "vc", "ws", "sm", "st", "sa", "sn", "rs", "sc", "sl", "sg", "sx", "sk", "si", "sb", "so", "za", "gs", "ss", "es", "lk", "sd", "sr", "sj", "se", "ch", "sy", "tw", "tj", "tz", "th", "tl", "tg", "tk", "to", "tt", "tn", "tr", "tm", "tc", "tv", "ug", "ua", "ae", "gb", "um", "us", "uy", "uz", "vu", "ve", "vn", "vg", "vi", "wf", "eh", "ye", "zm", "zw" ], "type": "string", "additionalProperties": false }, "CreateAssociatedPersonRequest": { "required": [ "date_of_birth", "first_name", "last_name", "relationship_type", "sex_at_birth" ], "type": "object", "properties": { "first_name": { "type": "string", "description": "Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "last_name": { "type": "string", "description": "Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "date_of_birth": { "type": "string", "description": "Must be in the past, but after 1900-01-01", "format": "date", "example": "2024-12-01" }, "sex_at_birth": { "allOf": [ { "$ref": "#/components/schemas/SexAtBirth" } ], "description": "The sex assigned to the associated person at birth" }, "relationship_type": { "allOf": [ { "$ref": "#/components/schemas/RelationshipType" } ], "description": "The relationship type between the employee and the associated person" }, "email": { "type": [ "null", "string" ], "description": "NOTE: This field will be normalized according to our internal formatting rules." }, "phone_number": { "type": [ "null", "string" ], "description": "Phone number in E.164 international format (e.g. +447700900999). NOTE: This field will be normalized according to our internal formatting rules." } }, "additionalProperties": false }, "CreateEmployeeBankAccount": { "required": [ "account_number" ], "type": "object", "properties": { "account_number": { "type": "string", "description": "Account number in IBAN format. NOTE: This field will be normalized according to our internal formatting rules." } }, "additionalProperties": false }, "CreateEmployeeRequest": { "required": [ "date_of_birth", "email", "employer_id", "first_name", "home_address", "last_name", "national_tax_id", "phone_number", "sex_at_birth", "start_on" ], "type": "object", "properties": { "employer_id": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only required for EoR platforms." }, "first_name": { "type": "string", "description": "It can include the middle name. Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "last_name": { "type": "string", "description": "Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "date_of_birth": { "type": "string", "description": "Must be in the past, but after 1900-01-01", "format": "date", "example": "2024-12-01" }, "sex_at_birth": { "allOf": [ { "$ref": "#/components/schemas/SexAtBirth" } ], "description": "The sex assigned to the employee at birth" }, "home_address": { "allOf": [ { "$ref": "#/components/schemas/AddressModel" } ], "description": "Location where the employee is legally registered to live" }, "nationality": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CountryCode" } ] }, "national_tax_id": { "type": "string", "description": "PPSN in Ireland, NINo in the UK, DNI/NIE in Spain. Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "start_on": { "type": "string", "description": "Employment start date. Must be after 1900-01-01, can be in the future", "format": "date", "example": "2024-12-01" }, "earliest_benefits_start_date": { "type": [ "null", "string" ], "description": "The earliest date this employee can be enrolled in any benefits. Before this date, the employee remains in a Pending state and is excluded from benefit activation.\n\n**Constraints:**\n\n- Must be a valid date.\n\n- Ignored for statutory schemes where immediate coverage is legally required. Example: Local Netherlands and UAE schemes.", "format": "date", "example": "2024-12-01" }, "phone_number": { "type": "string", "description": "Phone number in E.164 international format (e.g. +447700900999). NOTE: This field will be normalized according to our internal formatting rules." }, "email": { "type": "string", "description": "Must not be empty. NOTE: This field will be normalized according to our internal formatting rules." }, "bank_account": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreateEmployeeBankAccount" } ], "description": "Bank account details" }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters." } }, "additionalProperties": false }, "CreateEmployerRequest": { "required": [ "contact", "legal_address", "legal_name" ], "type": "object", "properties": { "legal_name": { "type": "string", "description": "Legal name of the company. NOTE: This field will be normalized according to our internal formatting rules." }, "registration_number": { "type": [ "null", "string" ], "description": "Company registration number. NOTE: This field will be normalized according to our internal formatting rules." }, "legal_address": { "allOf": [ { "$ref": "#/components/schemas/AddressModel" } ] }, "contact": { "allOf": [ { "$ref": "#/components/schemas/ContactModel" } ] }, "earliest_benefits_start_date": { "type": [ "null", "string" ], "description": "The earliest date this employer is permitted to set up any benefits scheme. If this date is in the future, benefit setup will be blocked until then. Used to delay scheme setup access (e.g., for onboarding alignment).\n\n**Constraints:**\n\n- Can only be set or updated if no group policy or group quote exists.\n- Must be a valid date in the future.", "format": "date", "example": "2024-12-01" }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters." } }, "additionalProperties": false }, "CreateEnrolmentIntentRequest": { "required": [ "employee_id", "force_confirmation", "group_id" ], "type": "object", "properties": { "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Identifier for the employee associated with this enrolment intent. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier for the group associated with this enrolment intent. Prefixed with `gr_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "policy_configuration": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyConfigurationRequest" } ], "description": "Policy configuration associated with this enrolment intent. You do not have to explicitly provide this field if you want to use the default policy configuration for the group. This simply lets you override specific settings for this enrolment intent." }, "force_confirmation": { "type": "boolean", "description": "If set to true, the system will always force the `PendingConfirmation` state before enrolling the employee, even if no action is required. This can be useful in scenarios where you want to ensure that the employee explicitly confirms their enrolment, regardless of their eligibility or any other factors. Defaults to false.", "example": true }, "coverage_selections": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageOptionSelectionRequest" }, "description": "Optional plan coverage option selections for policy-scoped configurations. If provided and valid, the coverage_options_required step will be skipped." } }, "additionalProperties": false }, "CreateGroupPolicyIntentRequest": { "required": [ "quote_intent_id" ], "type": "object", "properties": { "quote_intent_id": { "pattern": "gqi_.+", "type": "string", "description": "Unique identifier for the group quote intent to create a policy intent from", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "cost_sharing": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCostSharingConfigurationResponse" } ], "description": "Cost sharing configuration override for the setup. If not provided, falls back to the quote intent's cost sharing." }, "consent_approvals": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ConsentApprovalInput" }, "description": "Consent approvals to record at the time of intent creation" } }, "additionalProperties": false }, "CreateGroupQuoteIntentRequest": { "required": [ "group_id", "plan_id" ], "type": "object", "properties": { "group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group to get a quote for", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "plan_id": { "pattern": "pl_.+", "type": "string", "description": "Unique identifier for the plan to get a quote for", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "cost_sharing": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCostSharingConfigurationResponse" } ], "description": "Cost sharing configuration for the quote" }, "expected_start_date": { "type": [ "null", "string" ], "description": "Expected start date for the insurance coverage", "format": "date", "example": "2024-12-01" }, "coverage_selections": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageOptionSelectionRequest" }, "description": "Plan coverage option selections for group-policy-scoped configurations." } }, "additionalProperties": false }, "CreateGroupRequest": { "required": [ "employer_id", "name" ], "type": "object", "properties": { "employer_id": { "pattern": "er_.+", "type": "string", "description": "Identifier of the `employer` to create the group for. Prefixed with `er_`.", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "Human-readable name of the `group`." }, "description": { "type": [ "null", "string" ], "description": "Short description of the purpose or scope of the `group`." } }, "additionalProperties": false }, "CreateHostedSessionTokenResponse": { "required": [ "expiry", "link" ], "type": "object", "properties": { "link": { "type": "string" }, "expiry": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" } }, "additionalProperties": false }, "CreatePolicyAmendmentIntentRequest": { "required": [ "amendment_reason", "requested_changes" ], "type": "object", "properties": { "amendment_reason": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentReasonRequest" } ], "description": "The reason for the policy amendment." }, "requested_changes": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyAmendmentRequestedChangeRequest" }, "description": "List of requested changes to the policy." } }, "additionalProperties": false }, "CreatePolicyImportIntentAssociatedPersonRequest": { "required": [ "associated_person_id" ], "type": "object", "properties": { "associated_person_id": { "pattern": "ap_.+", "type": "string", "description": "The associated person ID. Prefixed with `ap_`.", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "member_number": { "type": [ "null", "string" ], "description": "The member number assigned by the provider for this associated person." }, "start_date": { "type": [ "null", "string" ], "description": "The start date for this associated person's coverage.", "format": "date", "example": "2024-12-01" }, "end_date": { "type": [ "null", "string" ], "description": "The end date for this associated person's coverage.", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "CreatePolicyImportIntentRequest": { "required": [ "employee_id", "group_id", "member_number", "policy_start_date", "provider_policy_number" ], "type": "object", "properties": { "employee_id": { "pattern": "ee_.+", "type": "string", "description": "The employee ID for the policy import. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "The group ID for the policy import. Prefixed with `g_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "provider_policy_number": { "type": "string", "description": "The provider's policy number." }, "member_number": { "type": "string", "description": "The member number assigned by the provider." }, "policy_start_date": { "type": "string", "description": "The start date of the policy.", "format": "date", "example": "2024-12-01" }, "policy_end_date": { "type": [ "null", "string" ], "description": "The end date of the policy. Leave null if the policy has no end date.", "format": "date", "example": "2024-12-01" }, "associated_persons": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreatePolicyImportIntentAssociatedPersonRequest" }, "description": "List of associated persons to be linked to this policy import." } }, "additionalProperties": false }, "CreateSalaryRequest": { "required": [ "amount", "currency", "effective_from", "pay_frequency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Salary amount, in the given currency and pay frequency. Must be greater than 0.", "format": "double", "example": 123.45 }, "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "ISO currency code the amount is denominated in" }, "pay_frequency": { "allOf": [ { "$ref": "#/components/schemas/PayFrequency" } ], "description": "The period this amount represents (e.g. annual, monthly)" }, "effective_from": { "type": "string", "description": "Date from which this salary is effective", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "CreateSessionTokenLinkRequest": { "required": [ "employee_id", "employer_id" ], "type": "object", "properties": { "employer_id": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "CreateSessionTokenRequest": { "required": [ "employer_id" ], "type": "object", "properties": { "employer_id": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": [ "null", "string" ], "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is required for Employer Session tokens for EoR platforms." } }, "additionalProperties": false }, "CreateSessionTokenResponse": { "required": [ "expiry", "token" ], "type": "object", "properties": { "token": { "type": "string" }, "expiry": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" } }, "additionalProperties": false }, "CurrencyCode": { "enum": [ "eur", "aed", "afn", "xcd", "all", "amd", "aoa", "ars", "usd", "aud", "awg", "azn", "bam", "bbd", "bdt", "xof", "bgn", "bhd", "bif", "bmd", "bnd", "bob", "bov", "brl", "bsd", "inr", "btn", "nok", "bwp", "byn", "bzd", "cad", "xaf", "cdf", "chf", "che", "chw", "nzd", "clp", "clf", "cny", "cop", "cou", "crc", "cup", "cuc", "cve", "ang", "czk", "djf", "dkk", "dop", "dzd", "egp", "mad", "ern", "etb", "fjd", "fkp", "mdl", "gbp", "gel", "ghs", "gip", "gmd", "gnf", "gtq", "gyd", "hkd", "hnl", "hrk", "htg", "huf", "idr", "xdr", "ils", "iqd", "irr", "isk", "jmd", "jod", "jpy", "kes", "kgs", "khr", "kmf", "kpw", "krw", "kwd", "kyd", "kzt", "lak", "lbp", "lkr", "lrd", "lsl", "zar", "lyd", "mga", "mkd", "mmk", "mnt", "mop", "mru", "mur", "mvr", "mwk", "mxn", "mxv", "myr", "mzn", "nad", "xpf", "ngn", "nio", "npr", "omr", "pab", "pen", "pgk", "php", "pkr", "pln", "pyg", "qar", "ron", "rsd", "rub", "rwf", "sar", "sbd", "scr", "sdg", "sek", "sgd", "shp", "sll", "sos", "srd", "ssp", "stn", "svc", "xsu", "syp", "twd", "szl", "thb", "tjs", "tmt", "tnd", "top", "try", "ttd", "tzs", "uah", "ugx", "usn", "uyu", "uyi", "uyw", "uzs", "ves", "vnd", "vuv", "wst", "yer", "xua", "zmw", "zwl" ], "type": "string" }, "DependentCoverageSelectionsRequest": { "required": [ "associated_person_id", "coverage_selections" ], "type": "object", "properties": { "associated_person_id": { "pattern": "ap_.+", "type": "string", "description": "The associated person ID this selection applies to.", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "coverage_selections": { "type": "array", "items": { "$ref": "#/components/schemas/PlanCoverageOptionSelectionRequest" }, "description": "Coverage option selections for member-scoped configurations." } }, "additionalProperties": false }, "DependentInfoResponse": { "required": [ "associated_person_id", "status" ], "type": "object", "properties": { "associated_person_id": { "pattern": "ap_.+", "type": "string", "description": "The associated person ID. Prefixed with `ap_`.", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "allOf": [ { "$ref": "#/components/schemas/DependentsManagementIntentDependentStatus" } ], "description": "The status of this dependent in the dependents management intent." }, "coverage_selections": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageOptionSelectionResponse" }, "description": "Coverage option selections for this dependent. Populated when member-scoped selections have been provided." }, "requirement_id": { "pattern": "ar_.+", "type": [ "null", "string" ], "description": "The adaptive requirement ID for this dependent. Populated when the dependent has an open adaptive requirement (status is `action_required`). Prefixed with `ar_`.", "example": "ar_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "DependentStatus": { "enum": [ "processing", "confirmed" ], "type": "string" }, "DependentsManagementIntentActionCode": { "enum": [ "remove_restricted_or_ineligible_dependents" ], "type": "string", "x-fern-enum": { "remove_restricted_or_ineligible_dependents": { "description": "One or more dependents are restricted or ineligible and must be removed before proceeding." } } }, "DependentsManagementIntentActionRequiredResponse": { "required": [ "code", "due_by", "reason", "reason_description" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/DependentsManagementIntentActionCode" } ], "description": "The action code indicating what action is required." }, "reason": { "type": "string", "description": "Brief reason for the required action." }, "reason_description": { "type": "string", "description": "Detailed description of the required action. This is intended to be understandable by the end user." }, "due_by": { "type": "string", "description": "The deadline by which the action must be completed. The day is included (i.e. the action can be completed any time during this day in the user's local time).", "format": "date-time", "example": "2024-12-01T00:00:00Z" } }, "additionalProperties": false }, "DependentsManagementIntentActionRequiredV2Webhook": { "title": "DependentsManagementIntentActionRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "dependents_management_intent.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/DependentsManagementIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "DependentsManagementIntentCompletedV2Webhook": { "title": "DependentsManagementIntentCompletedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "dependents_management_intent.completed" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/DependentsManagementIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "DependentsManagementIntentDependentStatus": { "enum": [ "pending_confirmation", "action_required", "ineligible", "processing", "restricted", "ready" ], "type": "string" }, "DependentsManagementIntentEventResponse": { "required": [ "dependents_management_intent_id", "parent_intent_id", "parent_intent_type" ], "type": "object", "properties": { "dependents_management_intent_id": { "pattern": "dmi_.+", "type": "string", "description": "Identifier of the dependents management intent associated with this event. Prefixed with `dmi_`.", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "parent_intent_id": { "type": "string", "description": "Identifier of the parent intent associated with this dependents management intent.", "format": "uuid" }, "parent_intent_type": { "allOf": [ { "$ref": "#/components/schemas/DependentsManagementIntentParentType" } ], "description": "Type of the parent intent." }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "DependentsManagementIntentNotUndertakenV2Webhook": { "title": "DependentsManagementIntentNotUndertakenV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "dependents_management_intent.not_undertaken" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/DependentsManagementIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "DependentsManagementIntentParentType": { "enum": [ "policy_amendment_intent", "enrolment_intent" ], "type": "string" }, "DependentsManagementIntentResponse": { "required": [ "dependents", "disclosures", "id", "parent_intent_id", "parent_intent_type", "plan", "status" ], "type": "object", "properties": { "id": { "pattern": "dmi_.+", "type": "string", "description": "Unique identifier for the dependents management intent. Prefixed with `dmi_`.", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "object": { "type": "string", "description": "Object type identifier.", "readOnly": true }, "parent_intent_id": { "type": "string", "description": "The parent intent ID (e.g. Policy Amendment Intent ID). Prefixed based on type." }, "parent_intent_type": { "allOf": [ { "$ref": "#/components/schemas/DependentsManagementIntentParentType" } ], "description": "The type of parent intent." }, "status": { "allOf": [ { "$ref": "#/components/schemas/DependentsManagementIntentStatus" } ], "description": "Current status of the dependents management intent." }, "dependents": { "type": "array", "items": { "$ref": "#/components/schemas/DependentInfoResponse" }, "description": "List of dependents being managed." }, "plan": { "allOf": [ { "$ref": "#/components/schemas/PlanWithPricingResponse" } ], "description": "Plan information including pricing details." }, "coverage_options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageResponse" }, "description": "Available member-scoped coverage options for the plan. Present when the plan has member-scoped coverage configurations." }, "disclosures": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureResponse" }, "description": "Disclosures associated with this intent." }, "action_required": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/DependentsManagementIntentActionRequiredResponse" } ], "description": "Details of the action required from the caller. Populated only when `status` is `action_required` and a required action has been recorded on the intent (e.g. restricted dependents detected by compliance screening)." } }, "additionalProperties": false }, "DependentsManagementIntentStatus": { "enum": [ "action_required", "processing", "completed", "not_undertaken" ], "type": "string", "x-fern-enum": { "action_required": { "description": "Dependents information needs to be provided." }, "processing": { "description": "Dependents are being validated and processed." }, "completed": { "description": "Dependents have been successfully processed and validated." }, "not_undertaken": { "description": "Dependents management intent has been aborted." } } }, "DisclosureCategory": { "enum": [ "regulatory", "provider", "intermediary" ], "type": "string" }, "DisclosureResponse": { "required": [ "category", "text", "type" ], "type": "object", "properties": { "category": { "allOf": [ { "$ref": "#/components/schemas/DisclosureCategory" } ], "description": "The category of the disclosure." }, "type": { "allOf": [ { "$ref": "#/components/schemas/DisclosureType" } ], "description": "The specific type of disclosure within its category." }, "text": { "type": "string", "description": "The disclosure statement text." } }, "additionalProperties": false }, "DisclosureType": { "enum": [ "intermediary_role", "intermediary_commission", "underwriter_disclaimer", "anti_selection_notice", "statement_of_needs", "product_information", "pre_existing_conditions", "statutory_warning" ], "type": "string" }, "EligibilityCheckPlanResponse": { "required": [ "description", "id", "name" ], "type": "object", "properties": { "id": { "pattern": "pl_.+", "type": "string", "description": "Unique identifier for the plan. Prefixed with `pl_`.", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "The name of the plan." }, "description": { "type": "string", "description": "Description of the plan." } }, "additionalProperties": false }, "EligibilityCheckReasonResponse": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable ineligibility reason code in snake_case." }, "message": { "type": "string", "description": "Human-readable description of the ineligibility reason." } }, "additionalProperties": false }, "EligibilityCheckResponse": { "required": [ "eligibility_status", "plan", "provider", "reasons" ], "type": "object", "properties": { "object": { "type": "string", "description": "The object type.", "readOnly": true }, "eligibility_status": { "allOf": [ { "$ref": "#/components/schemas/EligibilityStatus" } ], "description": "Eligibility status: `eligible` or `ineligible`." }, "reasons": { "type": "array", "items": { "$ref": "#/components/schemas/EligibilityCheckReasonResponse" }, "description": "List of reasons why the employee is ineligible. Empty if eligible." }, "provider": { "allOf": [ { "$ref": "#/components/schemas/PlanProviderResponse" } ], "description": "The insurance provider associated with the group." }, "plan": { "allOf": [ { "$ref": "#/components/schemas/EligibilityCheckPlanResponse" } ], "description": "The insurance plan associated with the group." } }, "additionalProperties": false }, "EligibilityStatus": { "enum": [ "pending", "eligible", "ineligible" ], "type": "string" }, "EmployeeBankAccount": { "required": [ "account_number_last4" ], "type": "object", "properties": { "account_number_last4": { "type": "string", "description": "Last 4 digits of the account number" } }, "additionalProperties": false }, "EmployeeCreatedV2Webhook": { "title": "EmployeeCreatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeCreatedWebhook": { "title": "EmployeeCreatedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployeeEligibilityCriterionResponse": { "required": [ "description", "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/EmployeeEligibilityCriterionType" } ], "description": "The type of eligibility criterion." }, "description": { "type": "string", "description": "Human-readable description of the criterion." }, "age_range": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/AgeRangeDetails" } ], "description": "Age range constraints. Only populated when type is `age_range`." } }, "additionalProperties": false }, "EmployeeEligibilityCriterionType": { "enum": [ "age_range" ], "type": "string" }, "EmployeeEventResponse": { "required": [ "employer_id", "id" ], "type": "object", "properties": { "id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Unique identifier for the employer", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters." }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "EmployeeHealthInsuranceOfferActionRequiredV2Webhook": { "title": "EmployeeHealthInsuranceOfferActionRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.offer.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsuranceOfferEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeHealthInsuranceOfferActionRequiredWebhook": { "title": "EmployeeHealthInsuranceOfferActionRequiredWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.offer.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsuranceOfferResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployeeHealthInsuranceOfferEventResponse": { "required": [ "employee_id", "employer_id", "id" ], "type": "object", "properties": { "id": { "pattern": "eeho_.+", "type": "string", "description": "Unique identifier for the offer", "example": "eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "The Id of the employer for which the offer is available", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "The Id of the employee for which the offer is available", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms." }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "EmployeeHealthInsuranceOfferResponse": { "required": [ "coverage_level", "employee_id", "employer_id", "id", "status" ], "type": "object", "properties": { "object": { "type": "string", "description": "The object type", "readOnly": true }, "id": { "pattern": "eeho_.+", "type": "string", "description": "Unique identifier for offer", "example": "eeho_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "The Id of the employer for which the offer is available", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "The Id of the employee for which the offer is available", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms." }, "status": { "allOf": [ { "$ref": "#/components/schemas/EmployeeHealthInsuranceOfferStatus" } ], "description": "Current status of offer" }, "required_action": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceRequiredActionResponse" } ], "description": "Required action to progress the offer, if any. Set only when `status` is `action_required`." }, "coverage_level": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCoverageLevelResponse" } ], "description": "Details about the coverage level for the offer. Only a single level of cover is available for a specific employee!" } }, "additionalProperties": false }, "EmployeeHealthInsuranceOfferResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeHealthInsuranceOfferResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "EmployeeHealthInsuranceOfferStatus": { "enum": [ "action_required", "not_undertaken", "accepted" ], "type": "string" }, "EmployeeHealthInsurancePolicyActivatedV2Webhook": { "title": "EmployeeHealthInsurancePolicyActivatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.policy.activated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeHealthInsurancePolicyActivatedWebhook": { "title": "EmployeeHealthInsurancePolicyActivatedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.policy.activated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployeeHealthInsurancePolicyCancelledV2Webhook": { "title": "EmployeeHealthInsurancePolicyCancelledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.policy.cancelled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeHealthInsurancePolicyCancelledWebhook": { "title": "EmployeeHealthInsurancePolicyCancelledWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.policy.cancelled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployeeHealthInsurancePolicyEventResponse": { "required": [ "employee_id", "employer_id", "id" ], "type": "object", "properties": { "id": { "pattern": "eehp_.+", "type": "string", "description": "Unique identifier for the policy", "example": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "The Id of the employer for which the policy is created", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "The Id of the employee for which the policy is created", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms." }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "EmployeeHealthInsurancePolicyExpiredV2Webhook": { "title": "EmployeeHealthInsurancePolicyExpiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.policy.expired" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeHealthInsurancePolicyExpiredWebhook": { "title": "EmployeeHealthInsurancePolicyExpiredWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.policy.expired" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployeeHealthInsurancePolicyImportedV2Webhook": { "title": "EmployeeHealthInsurancePolicyImportedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.health_insurance.policy.imported" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeHealthInsurancePolicyResponse": { "required": [ "coverage_level", "employee_id", "employer_id", "end_date", "enrolled_dependants_count", "enrolment_type", "estimated_gross_premium", "id", "opt_out_deadline_date", "renewal", "start_date", "status" ], "type": "object", "properties": { "object": { "type": "string", "description": "The object type", "readOnly": true }, "id": { "pattern": "eehp_.+", "type": "string", "description": "Unique identifier for policy", "example": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "The Id of the employer for which the policy is created", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "The Id of the employee for which the policy is created", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "external_customer_id": { "type": [ "null", "string" ], "description": "A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms." }, "start_date": { "type": "string", "description": "Policy starts on this date", "format": "date", "example": "2024-12-01" }, "end_date": { "type": "string", "description": "Policy ends on this date", "format": "date", "example": "2024-12-01" }, "cancellation_date": { "type": [ "null", "string" ], "description": "Policy was cancelled on this date, if cancellation occured", "format": "date", "example": "2024-12-01" }, "policy_number": { "type": [ "null", "string" ], "description": "Health insurance policy number, if available" }, "status": { "allOf": [ { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyStatus" } ], "description": "Current status of policy" }, "enrolment_type": { "allOf": [ { "$ref": "#/components/schemas/EnrolmentType" } ], "description": "Enrolment type of the policy" }, "renewal": { "allOf": [ { "$ref": "#/components/schemas/EmployeeHealthPolicyRenewal" } ], "description": "Renewal information for the policy" }, "opt_out_deadline_date": { "type": "string", "description": "Last day to opt out from the policy", "format": "date", "example": "2024-12-01" }, "coverage_level": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCoverageLevelResponse" } ], "description": "Represents the current coverage level for the policy" }, "enrolled_dependants_count": { "type": "integer", "description": "Number of dependants (spouse, children, or other eligible family members) currently enrolled in this health insurance policy.", "format": "int32", "example": 123 }, "estimated_gross_premium": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceEstimatedGrossPremiumResponse" } ], "description": "Estimated gross premium amounts for this health insurance policy based on current enrollment and policy configuration. Important: These estimates are for planning purposes only and may differ from actual billed amounts due to life events, policy changes, insurer billing practices, or timing adjustments. For accurate payroll amounts, use the Contribution Reporting API." } }, "additionalProperties": false }, "EmployeeHealthInsurancePolicyResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "EmployeeHealthInsurancePolicyStatus": { "enum": [ "scheduled", "active", "expired", "cancelled" ], "type": "string" }, "EmployeeHealthInsurancePolicyStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyStatus" } } }, "additionalProperties": false }, "EmployeeHealthPolicyRenewal": { "required": [ "decision_confirmed", "renewal_date", "status", "window_end_date", "window_start_date" ], "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/EmployerHealthInsurancePolicyRenewalStatus" } ], "description": "The current status of the renewal" }, "renewal_date": { "type": "string", "description": "Policy renewal date", "format": "date", "example": "2024-12-01" }, "window_start_date": { "type": "string", "description": "Renewal window starts on this day", "format": "date", "example": "2024-12-01" }, "window_end_date": { "type": "string", "description": "Renewal window ends at the end of this day", "format": "date", "example": "2024-12-01" }, "decision_confirmed": { "type": "boolean", "description": "Whether the decision to renew the policy has been confirmed", "example": true }, "renewed_health_insurance_id": { "pattern": "eehp_.+", "type": [ "null", "string" ], "description": "The ID of the renewed health insurance policy, if renewed", "example": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "EmployeeOffboardedV2Webhook": { "title": "EmployeeOffboardedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.offboarded" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeOffboardedWebhook": { "title": "EmployeeOffboardedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.offboarded" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployeeResponse": { "required": [ "date_of_birth", "email", "first_name", "last_name", "national_tax_id", "phone_number", "sex_at_birth" ], "type": "object", "properties": { "platform_id": { "pattern": "pt_.+", "type": "string", "description": "Unique identifier for the platform", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Unique identifier for the employer", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "allOf": [ { "$ref": "#/components/schemas/EmployeeStatus" } ], "description": "Current status of the employee" }, "external_customer_id": { "type": [ "null", "string" ], "description": "A unique identifier assigned by the Employer of Record (EoR) platform to the Customer (i.e. the company using the EoR service) for which the employee is employed. This ID groups employees under this Customer, enabling the aggregation of contribution reporting and other values per Customer rather than per legal entity. This parameter is only available to EoR platforms." }, "first_name": { "type": "string", "description": "First name of the employee. It can include the middle name" }, "last_name": { "type": "string", "description": "Last name of the employee" }, "date_of_birth": { "type": "string", "description": "Date of birth of the employee", "format": "date", "example": "2024-12-01" }, "sex_at_birth": { "allOf": [ { "$ref": "#/components/schemas/SexAtBirth" } ], "description": "The sex assigned to the employee at birth" }, "home_address": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/AddressModel" } ], "description": "Location where the employee is legally registered to live" }, "nationality": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CountryCode" } ], "description": "Nationality of the employee (e.g. IE for Ireland, GB for United Kingdom, ES for Spain)" }, "national_tax_id": { "type": "string", "description": "PPSN in Ireland, NINo in the UK, DNI/NIE in Spain" }, "start_on": { "type": "string", "description": "Employment start date", "format": "date", "example": "2024-12-01" }, "earliest_benefits_start_date": { "type": [ "null", "string" ], "description": "The earliest date this employee can be enrolled in any benefits. Before this date, the employee remains in a Pending state and is excluded from benefit activation. Ignored for statutory schemes where immediate coverage is legally required. Example: Local Netherlands and UAE schemes.", "format": "date", "example": "2024-12-01" }, "phone_number": { "type": "string", "description": "Phone number in E.164 international format (e.g. +447700900999)" }, "email": { "type": "string", "description": "Email address of the employee" }, "offboard_on": { "type": [ "null", "string" ], "description": "Date when the employee was or will be offboarded", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "bank_account": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EmployeeBankAccount" } ], "description": "Bank account details" }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters." }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "EmployeeResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "EmployeeSalaryCreatedV2Webhook": { "title": "EmployeeSalaryCreatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.salary_created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/SalaryEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeSalaryDeletedV2Webhook": { "title": "EmployeeSalaryDeletedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.salary_deleted" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/SalaryEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeStatus": { "enum": [ "pending", "active", "offboarding", "inactive", "restricted" ], "type": "string" }, "EmployeeStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeStatus" } } }, "additionalProperties": false }, "EmployeeUpdatedV2Webhook": { "title": "EmployeeUpdatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployeeUpdatedWebhook": { "title": "EmployeeUpdatedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employee.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployeeResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployeesCountDetails": { "type": "object", "properties": { "min": { "type": [ "null", "integer" ], "description": "Minimum number of employees required.", "format": "int32" }, "max": { "type": [ "null", "integer" ], "description": "Maximum number of employees allowed.", "format": "int32" } }, "additionalProperties": false }, "EmployerCreatedV2Webhook": { "title": "EmployerCreatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerCreatedWebhook": { "title": "EmployerCreatedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployerEligibilityCriterionResponse": { "required": [ "description", "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/EmployerEligibilityCriterionType" } ], "description": "The type of eligibility criterion." }, "description": { "type": "string", "description": "Human-readable description of the criterion." }, "employees_count": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EmployeesCountDetails" } ], "description": "Employee count constraints. Only populated when type is `employees_count`." }, "members_count": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/MembersCountDetails" } ], "description": "Member count constraints. Only populated when type is `members_count`." }, "industry_exclusions": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/IndustryExclusionsDetails" } ], "description": "Industry exclusion details. Only populated when type is `industry_exclusions`." } }, "additionalProperties": false }, "EmployerEligibilityCriterionType": { "enum": [ "employees_count", "members_count", "industry_exclusions" ], "type": "string" }, "EmployerEventResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "er_.+", "type": "string", "description": "Unique identifier for the employer", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters." }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "EmployerHealthInsurancePolicyRenewalStatus": { "enum": [ "upcoming", "open", "renewed", "cancelled" ], "type": "string" }, "EmployerHealthInsurancePolicyResponse": { "required": [ "coverage_levels", "employer_cancellation_period_length", "employer_id", "end_date", "enrolment_type", "id", "renewal", "start_date", "status" ], "type": "object", "properties": { "object": { "type": "string", "description": "The object type", "readOnly": true }, "id": { "pattern": "erhp_.+", "type": "string", "description": "Unique identifier for policy", "example": "erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "The Id of the employer for which the policy is created", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "start_date": { "type": "string", "description": "Policy starts on this date", "format": "date", "example": "2024-12-01" }, "end_date": { "type": "string", "description": "Policy ends on this date", "format": "date", "example": "2024-12-01" }, "cancellation_date": { "type": [ "null", "string" ], "description": "Policy was cancelled on this date, if cancellation occured", "format": "date", "example": "2024-12-01" }, "group_policy_number": { "type": [ "null", "string" ], "description": "Group’s health insurance policy number, if available" }, "status": { "allOf": [ { "$ref": "#/components/schemas/EmployerHealthInsurancePolicyStatus" } ], "description": "Current status of policy" }, "enrolment_type": { "allOf": [ { "$ref": "#/components/schemas/EnrolmentType" } ], "description": "Enrolment type of the policy" }, "renewal": { "allOf": [ { "$ref": "#/components/schemas/GetEmployerHealthPolicyRenewal" } ], "description": "Renewal information for the policy" }, "employer_cancellation_period_length": { "type": "integer", "description": "How many days the employer has to cancel the policy since the policy starts", "format": "int32", "example": 123 }, "coverage_levels": { "type": "array", "items": { "$ref": "#/components/schemas/HealthInsuranceCoverageLevelResponse" }, "description": "Represents the available coverage levels for this policy" } }, "additionalProperties": false }, "EmployerHealthInsurancePolicyResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmployerHealthInsurancePolicyResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "EmployerHealthInsurancePolicyStatus": { "enum": [ "scheduled", "active", "expired", "cancelled" ], "type": "string" }, "EmployerHealthInsurancePolicyStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/EmployerHealthInsurancePolicyStatus" } } }, "additionalProperties": false }, "EmployerHealthInsuranceQuoteAcceptedV2Webhook": { "title": "EmployerHealthInsuranceQuoteAcceptedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.accepted" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerHealthInsuranceQuoteAcceptedWebhook": { "title": "EmployerHealthInsuranceQuoteAcceptedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.accepted" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployerHealthInsuranceQuoteActionRequiredV2Webhook": { "title": "EmployerHealthInsuranceQuoteActionRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerHealthInsuranceQuoteActionRequiredWebhook": { "title": "EmployerHealthInsuranceQuoteActionRequiredWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployerHealthInsuranceQuoteCreatedV2Webhook": { "title": "EmployerHealthInsuranceQuoteCreatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerHealthInsuranceQuoteCreatedWebhook": { "title": "EmployerHealthInsuranceQuoteCreatedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployerHealthInsuranceQuoteEventResponse": { "required": [ "employer_id", "id" ], "type": "object", "properties": { "id": { "pattern": "erhq_.+", "type": "string", "description": "Unique identifier for the quote", "example": "erhq_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "The Id of the employer for which the is created", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "EmployerHealthInsuranceQuoteNotUndertakenV2Webhook": { "title": "EmployerHealthInsuranceQuoteNotUndertakenV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.not_undertaken" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerHealthInsuranceQuoteNotUndertakenWebhook": { "title": "EmployerHealthInsuranceQuoteNotUndertakenWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.not_undertaken" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployerHealthInsuranceQuotePendingInsurerAcceptanceV2Webhook": { "title": "EmployerHealthInsuranceQuotePendingInsurerAcceptanceV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.pending_insurer_acceptance" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook": { "title": "EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.pending_insurer_acceptance" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployerHealthInsuranceQuotePendingV2Webhook": { "title": "EmployerHealthInsuranceQuotePendingV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.pending_quote" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerHealthInsuranceQuotePendingWebhook": { "title": "EmployerHealthInsuranceQuotePendingWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.health_insurance.quote.pending_quote" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployerHealthInsuranceQuoteResponse": { "required": [ "coverage_levels", "employer_id", "id", "quoted_at", "status" ], "type": "object", "properties": { "object": { "type": "string", "description": "The object type", "readOnly": true }, "id": { "pattern": "erhq_.+", "type": "string", "description": "Unique identifier for the quote", "example": "erhq_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "The Id of the employer for which the is created", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "quoted_at": { "type": "string", "description": "Date and time the quote was created at", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteStatus" } ], "description": "Current status of the quote" }, "required_action": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceRequiredActionResponse" } ], "description": "Actions required by the employer to proceed with the quote. Set only when `status` is `action_required`." }, "coverage_levels": { "type": "array", "items": { "$ref": "#/components/schemas/HealthInsuranceCoverageLevelResponse" }, "description": "List of levels covered under the policy, each item representing details about the plan’s cover. Currently Kota only supports a single level of cover." } }, "additionalProperties": false }, "EmployerHealthInsuranceQuoteResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "EmployerHealthInsuranceQuoteStatus": { "enum": [ "pending_quote", "action_required", "not_undertaken", "accepted", "pending_insurer_acceptance" ], "type": "string" }, "EmployerHealthInsuranceQuoteStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteStatus" } } }, "additionalProperties": false }, "EmployerOffboardedV2Webhook": { "title": "EmployerOffboardedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.offboarded" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerOffboardedWebhook": { "title": "EmployerOffboardedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.offboarded" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EmployerResponse": { "required": [ "contact", "id", "legal_address", "legal_name" ], "type": "object", "properties": { "id": { "pattern": "er_.+", "type": "string", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "platform_id": { "pattern": "pt_.+", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "allOf": [ { "$ref": "#/components/schemas/EmployerStatus" } ] }, "legal_name": { "type": "string" }, "registration_number": { "type": [ "null", "string" ] }, "legal_address": { "allOf": [ { "$ref": "#/components/schemas/AddressModel" } ] }, "contact": { "allOf": [ { "$ref": "#/components/schemas/ContactModel" } ] }, "offboard_on": { "type": [ "null", "string" ], "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "earliest_benefits_start_date": { "type": [ "null", "string" ], "format": "date", "example": "2024-12-01" }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters." }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "EmployerResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EmployerResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "EmployerStatus": { "enum": [ "pending", "active", "offboarding", "inactive", "restricted" ], "type": "string" }, "EmployerStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/EmployerStatus" } } }, "additionalProperties": false }, "EmployerUpdatedV2Webhook": { "title": "EmployerUpdatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EmployerUpdatedWebhook": { "title": "EmployerUpdatedWebhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "api_version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "employer.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EmployerResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "api_version": { "type": "string", "example": "1.0" } } }, "EnrolmentIntentActionRequiredResponse": { "required": [ "code", "due_by", "reason", "reason_description" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/IntentActionType" } ], "description": "The action code indicating what action is required." }, "reason": { "type": "string", "description": "Brief reason for the required action." }, "reason_description": { "type": "string", "description": "Detailed description of the required action." }, "due_by": { "type": "string", "description": "The deadline by which the action must be completed. The day is included (i.e. the action can be completed any time during this day in the user's local time).", "format": "date-time", "example": "2024-12-01T00:00:00Z" } }, "additionalProperties": false }, "EnrolmentIntentActionRequiredV2Webhook": { "title": "EnrolmentIntentActionRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentAssociatedPersonResponse": { "required": [ "dependent", "optional", "type" ], "type": "object", "properties": { "optional": { "type": "boolean", "description": "Indicates whether providing information for the related type is optional.", "example": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/AssociatedPersonType" } ], "description": "The type of associated person." }, "dependent": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EnrolmentIntentDependentResponse" } ], "description": "Dependents-specific information if type is 'dependents'." } }, "additionalProperties": false }, "EnrolmentIntentConfirmationType": { "enum": [ "confirm_enrolment" ], "type": "string" }, "EnrolmentIntentCoverageOptionsRequiredV2Webhook": { "title": "EnrolmentIntentCoverageOptionsRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.coverage_options_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentDependentResponse": { "required": [ "intent_id", "status" ], "type": "object", "properties": { "intent_id": { "pattern": "dmi_.+", "type": "string", "description": "Unique identifier for the dependents management intent. Prefixed with `dmi_`.", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "allOf": [ { "$ref": "#/components/schemas/DependentStatus" } ], "description": "Current status of the dependent." } }, "additionalProperties": false }, "EnrolmentIntentEnrolledV2Webhook": { "title": "EnrolmentIntentEnrolledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.enrolled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentEnrollingV2Webhook": { "title": "EnrolmentIntentEnrollingV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.enrolling" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentEventResponse": { "required": [ "employee_id", "enrolment_intent_id", "group_id" ], "type": "object", "properties": { "enrolment_intent_id": { "pattern": "ei_.+", "type": "string", "description": "Identifier of the enrolment intent associated with this event. Prefixed with `ei_`.", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Identifier of the employee associated with this enrolment intent. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier of the group associated with this enrolment intent. Prefixed with `gp_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "EnrolmentIntentInelgibilityReason": { "required": [ "code", "reason" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/EnrolmentIntentIneligibilityReasonCode" } ], "description": "Code representing the reason for ineligibility. This can be used to programmatically handle different ineligibility scenarios. As these amount of codes could increase with new providers we strongly suggest to use the fallback public message for displaying to end users." }, "reason": { "type": "string", "description": "A reason that can be displayed to the end user explaining why the enrolment intent is ineligible." } }, "additionalProperties": false }, "EnrolmentIntentIneligibilityReasonCode": { "enum": [ "employee_restricted", "employee_under_minimum_age", "employee_above_maximum_age", "employee_not_active", "employment_not_started", "unknown" ], "type": "string" }, "EnrolmentIntentIneligibleV2Webhook": { "title": "EnrolmentIntentIneligibleV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.ineligible" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentNotUndertakenV2Webhook": { "title": "EnrolmentIntentNotUndertakenV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.not_undertaken" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentPendingConfirmationResponse": { "required": [ "code", "due_by", "reason", "reason_description" ], "type": "object", "properties": { "due_by": { "type": "string", "description": "The deadline by which the confirmation must be completed.", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "code": { "allOf": [ { "$ref": "#/components/schemas/EnrolmentIntentConfirmationType" } ], "description": "The code for the confirmation that needs to be taken." }, "reason": { "type": "string", "description": "A reason for the confirmation action that needs to be taken. " }, "reason_description": { "type": "string", "description": "A reason description explaining the confirmation action that needs to be taken. " }, "associated_persons": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EnrolmentIntentAssociatedPersonResponse" } ], "description": "Information about associated persons related to this enrolment. Used to manage dependents." } }, "additionalProperties": false }, "EnrolmentIntentPendingConfirmationV2Webhook": { "title": "EnrolmentIntentPendingConfirmationV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.pending_confirmation" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentPolicyEnrolmentResponse": { "required": [ "estimated_effective_from", "plan", "provider", "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PolicyType" } ], "description": "Type of policy to be created as part of this enrolment intent." }, "estimated_effective_from": { "type": "string", "description": "Estimated date when the policy of this type is expected to become effective in ISO 8601 (YYYY-MM-DD).", "format": "date", "example": "2024-12-01" }, "provider": { "allOf": [ { "$ref": "#/components/schemas/PolicyProviderResponse" } ], "description": "Provider information for this policy (from group policy)." }, "plan": { "allOf": [ { "$ref": "#/components/schemas/PolicyPlanResponse" } ], "description": "Plan information for this policy (from group policy)." }, "health_insurance": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceEnrolmentIntentResponse" } ], "description": "Health insurance intent information (always present when type=health_insurance)." }, "id": { "pattern": "p_.+", "type": [ "null", "string" ], "description": "Unique identifier for the policy created as part of this enrolment intent. Prefixed with `p_`. Only populated once the policy has been created.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "EnrolmentIntentProcessingV2Webhook": { "title": "EnrolmentIntentProcessingV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.processing" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentRequirementResponse": { "required": [ "id", "is_fulfilled", "object_id", "object_type", "requirement_type" ], "type": "object", "properties": { "id": { "pattern": "ar_.+", "type": "string", "description": "Unique identifier for the requirement", "example": "ar_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "object_type": { "allOf": [ { "$ref": "#/components/schemas/RequirementObjectType" } ], "description": "Type of object this requirement is for (employee or employer)" }, "object_id": { "type": "string", "description": "Identifier of the object (employee ID or employer ID)" }, "is_fulfilled": { "type": "boolean", "description": "Whether the requirement has been fulfilled", "example": true }, "requirement_type": { "allOf": [ { "$ref": "#/components/schemas/RequirementType" } ], "description": "Type of requirement" }, "object": { "type": "string", "description": "Object type identifier", "readOnly": true } }, "additionalProperties": false }, "EnrolmentIntentRequirementResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnrolmentIntentRequirementResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "EnrolmentIntentResponse": { "required": [ "disclosures", "employee_id", "force_confirmation", "group_id", "id", "policy_enrolments", "status" ], "type": "object", "properties": { "id": { "pattern": "ei_.+", "type": "string", "description": "Unique identifier for the enrolment intent. Prefixed with `ei_`.", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Identifier for the employee associated with this enrolment intent. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier for the group associated with this enrolment intent. Prefixed with `gr_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "allOf": [ { "$ref": "#/components/schemas/EnrolmentIntentStatus" } ], "description": "Current status of the enrolment intent." }, "force_confirmation": { "type": "boolean", "description": "If set to true, the system will always force the `PendingConfirmation` state before enrolling the employee, even if no action is required. This can be useful in scenarios where you want to ensure that the employee explicitly confirms their enrolment, regardless of their eligibility or any other factors. Defaults to false.", "example": true }, "policy_enrolments": { "type": "array", "items": { "$ref": "#/components/schemas/EnrolmentIntentPolicyEnrolmentResponse" }, "description": "Policy enrolment information" }, "object": { "type": "string", "description": "Object type identifier.", "readOnly": true }, "ineligibility_reason": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EnrolmentIntentInelgibilityReason" } ], "description": "If the enrolment intent status is `ineligible`, this field provides details about the reason for employees ineligibility." }, "policy_configuration": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyConfigurationResponse" } ], "description": "Policy configuration associated with this enrolment intent." }, "action_required": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EnrolmentIntentActionRequiredResponse" } ], "description": "If the enrolment intent status is `action_required`, this field provides details about the action that needs to be taken to proceed with the enrolment." }, "pending_confirmation": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/EnrolmentIntentPendingConfirmationResponse" } ], "description": "If the enrolment intent status is `pending_confirmation`, this field provides details about the pending confirmation state." }, "disclosures": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureResponse" }, "description": "Disclosures associated with this intent." } }, "additionalProperties": false }, "EnrolmentIntentResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnrolmentIntentResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "EnrolmentIntentScheduledV2Webhook": { "title": "EnrolmentIntentScheduledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "enrolment_intent.scheduled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/EnrolmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "EnrolmentIntentStatus": { "enum": [ "processing", "scheduled", "action_required", "coverage_options_required", "pending_confirmation", "enrolling", "enrolled", "not_undertaken", "ineligible", "rejected" ], "type": "string" }, "EnrolmentIntentStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/EnrolmentIntentStatus" } } }, "additionalProperties": false }, "EnrolmentReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "ei_.+", "type": "string", "description": "Unique identifier for the enrolment.", "example": "ei_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "EnrolmentStatus": { "enum": [ "enrolled", "enrolling", "opted_out", "cancelled", "enrolment_available", "not_available", "rejected" ], "type": "string" }, "EnrolmentType": { "enum": [ "opt_out", "opt_in" ], "type": "string" }, "EventResponse": { "required": [ "created", "data", "id", "platform_id", "type" ], "type": "object", "properties": { "id": { "pattern": "evt_.+", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "platform_id": { "pattern": "pt_.+", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "created": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "type": { "type": "string" }, "data": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ] }, "api_version": { "type": "string", "readOnly": true } }, "additionalProperties": false }, "EventResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EventResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "FamilyTierCode": { "enum": [ "single", "couple", "single_parent", "family" ], "type": "string" }, "GetContributionReportPeriod": { "required": [ "from_date", "to_date" ], "type": "object", "properties": { "from_date": { "type": "string", "description": "Start date of the period", "format": "date", "example": "2024-12-01" }, "to_date": { "type": "string", "description": "End date of the period", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "GetEmployeeBreakdownContribution": { "required": [ "adjustment", "amount", "category", "cover_period", "employee_policy_id", "id", "member_type", "policy_id", "reporting_month", "type" ], "type": "object", "properties": { "id": { "pattern": "ct_.+", "type": "string", "description": "Unique identifier for the contribution entry", "example": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "category": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceContributionCategory" } ], "description": "Category of the contribution" }, "member_type": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceContributionMemberType" } ], "description": "Type of member for the contribution" }, "adjustment": { "type": "boolean", "description": "Indicates if this contribution is an adjustment to a previous charge", "example": true }, "adjustment_for": { "pattern": "ct_.+", "type": [ "null", "string" ], "description": "Unique identifier of the original contribution being adjusted, if applicable", "example": "ct_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "amount": { "type": "number", "description": "The monetary value of the contribution", "format": "double", "example": 123.45 }, "type": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceContributionType" } ], "description": "Type of the contribution" }, "note": { "type": [ "null", "string" ], "description": "Optional field for additional context, e.g. if the amount is pro-rated or backdated" }, "cover_period": { "allOf": [ { "$ref": "#/components/schemas/GetEmployeeBreakdownPeriod" } ], "description": "The health insurance period the contribution applies to" }, "policy_id": { "pattern": "p_.+", "type": "string", "description": "The policy the contribution applies to. Prefixed with `p_`.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_policy_id": { "pattern": "eehp_.+", "type": "string", "description": "DEPRECATED: Use `policy_id` instead. The employee health insurance policy the contribution applies to. Prefixed with `eehp_`.", "example": "eehp_3b1333d87d9d4fd6ad83ba7f6b0e951a", "deprecated": true }, "reporting_month": { "type": "string", "description": "The primary month for which the contribution is relevant, helping to align contributions with standard monthly reporting cycles. It allows for consistent monthly categorisation in systems that require calendar-based reporting. Provided in `YYYY-MM-DD` format (with the day set to `01` as a convention), only the year and month are relevant.", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "GetEmployeeBreakdownHealthInsurance": { "required": [ "employee_contributions", "employer_contributions" ], "type": "object", "properties": { "employer_contributions": { "type": "array", "items": { "$ref": "#/components/schemas/GetEmployeeBreakdownContribution" }, "description": "Employer health insurance contributions" }, "employee_contributions": { "type": "array", "items": { "$ref": "#/components/schemas/GetEmployeeBreakdownContribution" }, "description": "Employee health insurance contributions" } }, "additionalProperties": false }, "GetEmployeeBreakdownPeriod": { "required": [ "from_date", "to_date" ], "type": "object", "properties": { "from_date": { "type": "string", "description": "Start date of the period", "format": "date", "example": "2024-12-01" }, "to_date": { "type": "string", "description": "End date of the period", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "GetEmployerHealthPolicyRenewal": { "required": [ "decision_confirmed", "renewal_date", "status", "window_end_date", "window_start_date" ], "type": "object", "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/EmployerHealthInsurancePolicyRenewalStatus" } ], "description": "The current status of the renewal" }, "renewal_date": { "type": "string", "description": "Policy renewal date", "format": "date", "example": "2024-12-01" }, "window_start_date": { "type": "string", "description": "Renewal window starts on this day", "format": "date", "example": "2024-12-01" }, "window_end_date": { "type": "string", "description": "Renewal window ends at the end of this day", "format": "date", "example": "2024-12-01" }, "decision_confirmed": { "type": "boolean", "description": "Whether the decision to renew the policy has been confirmed", "example": true }, "renewed_health_insurance_id": { "pattern": "erhp_.+", "type": [ "null", "string" ], "description": "The ID of the renewed health insurance policy, if renewed", "example": "erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "GroupArchivedV2Webhook": { "title": "GroupArchivedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.archived" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupCreatedV2Webhook": { "title": "GroupCreatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupEmployeeAddedV2Webhook": { "title": "GroupEmployeeAddedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.employee.added" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEmployeeEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupEmployeeEligibleV2Webhook": { "title": "GroupEmployeeEligibleV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.employee.eligible" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEmployeeEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupEmployeeEventResponse": { "required": [ "employee_id", "group_id" ], "type": "object", "properties": { "group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "GroupEmployeeMoveScheduledEventResponse": { "required": [ "current_group_id", "employee_id", "new_group_id", "scheduled_date" ], "type": "object", "properties": { "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "current_group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the employee's current group", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "new_group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group the employee will be moved to", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "scheduled_date": { "type": "string", "description": "The date when the employee will be moved to the new group", "format": "date", "example": "2024-12-01" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "GroupEmployeeMoveScheduledV2Webhook": { "title": "GroupEmployeeMoveScheduledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.employee.move.scheduled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEmployeeMoveScheduledEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupEmployeeMovedEventResponse": { "required": [ "employee_id", "new_group_id", "previous_group_id" ], "type": "object", "properties": { "previous_group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group the employee was moved from", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "new_group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group the employee was moved to", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "GroupEmployeeMovedV2Webhook": { "title": "GroupEmployeeMovedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.employee.moved" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEmployeeMovedEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupEmployeeRemovedEventResponse": { "required": [ "employee_id", "employer_id", "group_id", "platform_id", "removed_at" ], "type": "object", "properties": { "platform_id": { "pattern": "pt_.+", "type": "string", "description": "Unique identifier for the platform", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Unique identifier for the employer", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "removed_at": { "type": "string", "description": "Timestamp when the employee was removed from the group", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "GroupEmployeeRemovedV2Webhook": { "title": "GroupEmployeeRemovedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.employee.removed" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEmployeeRemovedEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupEmployeeResponse": { "required": [ "eligibility_status", "enrolment_status", "enrolments", "group_id", "id", "policies", "scheduled_group_transitions" ], "type": "object", "properties": { "object": { "type": "string", "description": "The object type", "readOnly": true }, "id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyReference" }, "description": "List of policies associated with the employee in this group." }, "enrolments": { "type": "array", "items": { "$ref": "#/components/schemas/EnrolmentReference" }, "description": "List of enrolments associated with the employee in this group." }, "desired_policy_start_date": { "type": [ "null", "string" ], "description": "The desired date for the employee's policy to start. This date is not guaranteed to be honored by the insurance provider and may be adjusted based on provider-specific rules and requirements.", "format": "date", "example": "2024-12-01" }, "enrolment_date": { "type": [ "null", "string" ], "description": "The date on which the employee agreed to enrol into the group's policies. This date may be used by some insurance providers to determine the policy start date.", "format": "date", "example": "2024-12-01" }, "eligibility_status": { "allOf": [ { "$ref": "#/components/schemas/EligibilityStatus" } ], "description": "Eligibility status for the employee in this group. `Pending` = no eligibility check performed (no group policy), `Eligible` = employee meets provider's eligibility criteria, `Ineligible` = employee does not meet eligibility criteria (e.g., age restrictions)." }, "enrolment_status": { "allOf": [ { "$ref": "#/components/schemas/EnrolmentStatus" } ], "description": "Enrolment status for the employee in this group. Derived from policy and enrolment intent statuses." }, "scheduled_group_transitions": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduledGroupTransitionResponse" }, "description": "List of scheduled group transitions for the employee. Only includes pending transitions." } }, "additionalProperties": false }, "GroupEmployeeResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupEmployeeResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "GroupEnrolmentType": { "enum": [ "manual", "automatic" ], "type": "string" }, "GroupEventResponse": { "required": [ "employer_id", "id" ], "type": "object", "properties": { "id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Unique identifier for the employer", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "GroupPolicyActiveV2Webhook": { "title": "GroupPolicyActiveV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy.active" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyCancelledV2Webhook": { "title": "GroupPolicyCancelledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy.cancelled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyEventResponse": { "required": [ "employer_id", "group_id", "group_policy_id" ], "type": "object", "properties": { "group_policy_id": { "pattern": "gp_.+", "type": "string", "description": "Identifier of the group policy associated with this event. Prefixed with `gp_`.", "example": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier of the group associated with this group policy. Prefixed with `gr_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Identifier for the employer associated with this group policy. Prefixed with `er_`.", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "GroupPolicyExpiredV2Webhook": { "title": "GroupPolicyExpiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy.expired" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyIntentActionRequiredResponse": { "required": [ "code", "due_by", "reason", "reason_description" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/IntentActionType" } ], "description": "The action code indicating what action is required." }, "reason": { "type": "string", "description": "Brief reason for the required action." }, "reason_description": { "type": "string", "description": "Detailed description of the required action." }, "due_by": { "type": "string", "description": "The deadline by which the action must be completed. The day is included (i.e. the action can be completed any time during this day in the user's local time).", "format": "date-time", "example": "2024-12-01T00:00:00Z" } }, "additionalProperties": false }, "GroupPolicyIntentActionRequiredV2Webhook": { "title": "GroupPolicyIntentActionRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy_intent.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyIntentEventResponse": { "required": [ "group_id", "group_policy_intent_id", "plan_id" ], "type": "object", "properties": { "group_policy_intent_id": { "pattern": "gpi_.+", "type": "string", "description": "Identifier of the group policy intent associated with this event. Prefixed with `gpi_`.", "example": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier of the group associated with this group policy intent. Prefixed with `gr_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "plan_id": { "pattern": "pl_.+", "type": "string", "description": "Identifier of the plan associated with this group policy intent. Prefixed with `pl_`.", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "GroupPolicyIntentExpiredV2Webhook": { "title": "GroupPolicyIntentExpiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy_intent.expired" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyIntentManualRenewalGatheringRequiredV2Webhook": { "title": "GroupPolicyIntentManualRenewalGatheringRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy_intent.manual_renewal_gathering_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyIntentPendingProviderApprovalV2Webhook": { "title": "GroupPolicyIntentPendingProviderApprovalV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy_intent.pending_provider_approval" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyIntentPolicyCreatedV2Webhook": { "title": "GroupPolicyIntentPolicyCreatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy_intent.policy_created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyIntentProcessingV2Webhook": { "title": "GroupPolicyIntentProcessingV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy_intent.processing" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyIntentProviderRejectedV2Webhook": { "title": "GroupPolicyIntentProviderRejectedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy_intent.provider_rejected" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyIntentRequirementResponse": { "required": [ "id", "is_fulfilled", "object_id", "object_type", "requirement_type" ], "type": "object", "properties": { "id": { "pattern": "ar_.+", "type": "string", "description": "Unique identifier for the requirement", "example": "ar_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "object_type": { "allOf": [ { "$ref": "#/components/schemas/RequirementObjectType" } ], "description": "Type of object this requirement is for (employee or employer)" }, "object_id": { "type": "string", "description": "Identifier of the object (employee ID or employer ID)" }, "is_fulfilled": { "type": "boolean", "description": "Whether the requirement has been fulfilled", "example": true }, "requirement_type": { "allOf": [ { "$ref": "#/components/schemas/RequirementType" } ], "description": "Type of requirement" }, "object": { "type": "string", "description": "Object type identifier", "readOnly": true } }, "additionalProperties": false }, "GroupPolicyIntentRequirementResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupPolicyIntentRequirementResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "GroupPolicyIntentResponse": { "required": [ "disclosures", "group_id", "id", "plan_id", "quote_intent_id", "status" ], "type": "object", "properties": { "id": { "pattern": "gpi_.+", "type": "string", "description": "Unique identifier for the group policy intent", "example": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "plan_id": { "pattern": "pl_.+", "type": "string", "description": "Unique identifier for the plan", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "quote_intent_id": { "pattern": "gqi_.+", "type": "string", "description": "Unique identifier for the group quote intent this policy intent was created from", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "allOf": [ { "$ref": "#/components/schemas/GroupPolicyIntentStatus" } ], "description": "Current status of the group policy intent" }, "due_date": { "type": [ "null", "string" ], "description": "Due date for the policy intent", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "cost_sharing": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCostSharingConfigurationResponse" } ], "description": "Cost sharing configuration for the policy intent" }, "action_required": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/GroupPolicyIntentActionRequiredResponse" } ], "description": "Details of the required action when the intent is in ActionRequired status." }, "disclosures": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureResponse" }, "description": "Disclosures associated with this intent." }, "object": { "type": "string", "description": "Object type identifier", "readOnly": true } }, "additionalProperties": false }, "GroupPolicyIntentResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupPolicyIntentResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "GroupPolicyIntentStatus": { "enum": [ "processing", "action_required", "pending_provider_approval", "policy_created", "expired", "provider_rejected", "manual_renewal_gathering_required" ], "type": "string" }, "GroupPolicyIntentStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/GroupPolicyIntentStatus" } } }, "additionalProperties": false }, "GroupPolicyRenewalCanceledV2Webhook": { "title": "GroupPolicyRenewalCanceledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy.renewal.canceled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyRenewalOpenedV2Webhook": { "title": "GroupPolicyRenewalOpenedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy.renewal.opened" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyRenewalRenewedV2Webhook": { "title": "GroupPolicyRenewalRenewedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy.renewal.renewed" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyResponse": { "required": [ "disclosures", "id", "plan", "provider", "start_date", "status", "type" ], "type": "object", "properties": { "id": { "pattern": "gp_.+", "type": "string", "description": "Unique identifier for the group policy. Prefixed with `gp_`.", "example": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier for the group associated with this group policy.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Identifier for the employer associated with this group policy.", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "start_date": { "type": "string", "description": "Policy start (effective) date in ISO 8601 (YYYY-MM-DD).", "format": "date", "example": "2024-12-01" }, "end_date": { "type": [ "null", "string" ], "description": "Policy end date (inclusive) in ISO 8601 (YYYY-MM-DD), or null if open-ended.", "format": "date", "example": "2024-12-01" }, "cancellation_date": { "type": [ "null", "string" ], "description": "Policy cancellation date (inclusive) in ISO 8610 (YYYY-MM-DD), or null if not applicable.", "format": "date", "example": "2024-12-01" }, "status": { "allOf": [ { "$ref": "#/components/schemas/GroupPolicyStatus" } ], "description": "Current lifecycle state of the `group_policy`, indicating its progress from creation to activation. Possible values are:\n - `scheduled`: Group policy has been scheduled for activation.\n - `active`: Group policy is now active\n - `expired`: Group policy is no longer active as it reached its end date\n - `cancelled`: Group policy is now cancelled for any reason." }, "type": { "allOf": [ { "$ref": "#/components/schemas/PolicyType" } ], "description": "Policy type. Determines which sub-object is populated." }, "provider": { "allOf": [ { "$ref": "#/components/schemas/PolicyProviderResponse" } ], "description": "Provider information for this policy." }, "plan": { "allOf": [ { "$ref": "#/components/schemas/PolicyPlanResponse" } ], "description": "Plan information for this policy" }, "health_insurance": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceGroupPolicyResponse" } ], "description": "Health insurance–specific fields (present when `type=health_insurance`)." }, "disclosures": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureResponse" }, "description": "Disclosures associated with this group policy." }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "GroupPolicyResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupPolicyResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "GroupPolicyScheduledV2Webhook": { "title": "GroupPolicyScheduledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy.scheduled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupPolicyStatus": { "enum": [ "scheduled", "active", "expired", "cancelled" ], "type": "string" }, "GroupPolicyStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/GroupPolicyStatus" } } }, "additionalProperties": false }, "GroupPolicyUpdatedV2Webhook": { "title": "GroupPolicyUpdatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_policy.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupPolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupQuoteIntentActionRequiredResponse": { "required": [ "code", "due_by", "reason", "reason_description" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/IntentActionType" } ], "description": "The action code indicating what action is required." }, "reason": { "type": "string", "description": "Brief reason for the required action." }, "reason_description": { "type": "string", "description": "Detailed description of the required action." }, "due_by": { "type": "string", "description": "The deadline by which the action must be completed. The day is included (i.e. the action can be completed any time during this day in the user's local time).", "format": "date-time", "example": "2024-12-01T00:00:00Z" } }, "additionalProperties": false }, "GroupQuoteIntentActionRequiredV2Webhook": { "title": "GroupQuoteIntentActionRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_quote_intent.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupQuoteIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupQuoteIntentAwaitingQuoteV2Webhook": { "title": "GroupQuoteIntentAwaitingQuoteV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_quote_intent.awaiting_quote" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupQuoteIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupQuoteIntentEventResponse": { "required": [ "group_id", "group_quote_intent_id", "plan_id" ], "type": "object", "properties": { "group_quote_intent_id": { "pattern": "gqi_.+", "type": "string", "description": "Identifier of the group quote intent associated with this event. Prefixed with `gqi_`.", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier of the group associated with this group quote intent. Prefixed with `gr_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "plan_id": { "pattern": "pl_.+", "type": "string", "description": "Identifier of the plan associated with this group quote intent. Prefixed with `pl_`.", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "GroupQuoteIntentProcessingV2Webhook": { "title": "GroupQuoteIntentProcessingV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_quote_intent.processing" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupQuoteIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupQuoteIntentQuoteAvailableV2Webhook": { "title": "GroupQuoteIntentQuoteAvailableV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_quote_intent.quote_available" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupQuoteIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupQuoteIntentQuoteExpiredV2Webhook": { "title": "GroupQuoteIntentQuoteExpiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_quote_intent.quote_expired" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupQuoteIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupQuoteIntentRejectedByInsurerV2Webhook": { "title": "GroupQuoteIntentRejectedByInsurerV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_quote_intent.rejected_by_insurer" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupQuoteIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupQuoteIntentRejectedV2Webhook": { "title": "GroupQuoteIntentRejectedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group_quote_intent.rejected" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupQuoteIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupQuoteIntentRequirementResponse": { "required": [ "id", "is_fulfilled", "object_id", "object_type", "requirement_type" ], "type": "object", "properties": { "id": { "pattern": "ar_.+", "type": "string", "description": "Unique identifier for the requirement", "example": "ar_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "object_type": { "allOf": [ { "$ref": "#/components/schemas/RequirementObjectType" } ], "description": "Type of object this requirement is for (employee or employer)" }, "object_id": { "type": "string", "description": "Identifier of the object (employee ID or employer ID)" }, "is_fulfilled": { "type": "boolean", "description": "Whether the requirement has been fulfilled", "example": true }, "requirement_type": { "allOf": [ { "$ref": "#/components/schemas/RequirementType" } ], "description": "Type of requirement" }, "object": { "type": "string", "description": "Object type identifier", "readOnly": true } }, "additionalProperties": false }, "GroupQuoteIntentRequirementResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupQuoteIntentRequirementResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "GroupQuoteIntentResponse": { "required": [ "consent_links", "disclosures", "group_id", "id", "plan_id", "status" ], "type": "object", "properties": { "id": { "pattern": "gqi_.+", "type": "string", "description": "Unique identifier for the group quote intent", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "plan_id": { "pattern": "pl_.+", "type": "string", "description": "Unique identifier for the plan", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "allOf": [ { "$ref": "#/components/schemas/GroupQuoteIntentStatus" } ], "description": "Current status of the group quote intent" }, "cost_sharing": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCostSharingConfigurationResponse" } ], "description": "Cost sharing configuration for the quote" }, "expected_start_date": { "type": [ "null", "string" ], "description": "Expected start date for the insurance coverage", "format": "date", "example": "2024-12-01" }, "action_required": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/GroupQuoteIntentActionRequiredResponse" } ], "description": "Details of the action required from the caller, if the intent is in action_required status." }, "consent_links": { "type": "array", "items": { "$ref": "#/components/schemas/ConsentLinkResponse" }, "description": "Consent links that need to be acknowledged" }, "disclosures": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureResponse" }, "description": "Disclosures associated with this intent." }, "object": { "type": "string", "description": "Object type identifier", "readOnly": true } }, "additionalProperties": false }, "GroupQuoteIntentResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupQuoteIntentResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "GroupQuoteIntentStatus": { "enum": [ "processing", "action_required", "awaiting_quote", "quote_available", "rejected", "rejected_by_insurer", "quote_expired" ], "type": "string" }, "GroupQuoteIntentStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/GroupQuoteIntentStatus" } } }, "additionalProperties": false }, "GroupQuoteResponse": { "required": [ "cost_sharing", "currency", "employee_count", "expires_at", "generated_at", "total_monthly_premium" ], "type": "object", "properties": { "employee_count": { "type": "integer", "description": "Number of employees covered by the quote", "format": "int32", "example": 123 }, "cost_sharing": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCostSharingConfigurationResponse" } ], "description": "Cost sharing configuration for the quote" }, "total_monthly_premium": { "type": "number", "description": "Total monthly premium for the group", "format": "double", "example": 123.45 }, "currency": { "type": "string", "description": "Currency of the premium (e.g. EUR, GBP)" }, "pdf_url": { "type": [ "null", "string" ], "description": "URL to download the quote PDF" }, "pdf_expires_at": { "type": [ "null", "string" ], "description": "When the PDF URL expires", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "generated_at": { "type": "string", "description": "When the quote was generated", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "expires_at": { "type": "string", "description": "When the quote expires", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "description": "Object type identifier", "readOnly": true } }, "additionalProperties": false }, "GroupReadyV2Webhook": { "title": "GroupReadyV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.ready" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "GroupResponse": { "required": [ "employer_id", "enrolment_type", "group_policy_ids", "group_policy_intent_ids", "group_quote_intent_ids", "group_type", "id", "name", "status" ], "type": "object", "properties": { "id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the `group`. Prefixed with `gr_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "Human-readable name of the `group`." }, "description": { "type": [ "null", "string" ], "description": "Short description of the purpose or scope of the `group`." }, "status": { "allOf": [ { "$ref": "#/components/schemas/GroupStatus" } ], "description": "Current lifecycle state of the `group`, indicating its current progress. Possible values are:\n - `pending`: Group is being configured, may require a `quote_intent` or a `setup_intent` to be ready.\n - `ready`: Setup is complete, regardless of policy start dates employees could start enrolling into policies.\n - `archived`: Archived as the group is no longer active or in use for any reason. Employees can no longer be added to the group." }, "group_type": { "allOf": [ { "$ref": "#/components/schemas/GroupType" } ], "description": "Indicates how policies are organized for this group.\n - `single`: exactly one policy is associated to the group.\n - `bundled`: multiple policies are bundled under the group.\n - `undefined`: type not yet determined or not applicable." }, "enrolment_type": { "allOf": [ { "$ref": "#/components/schemas/GroupEnrolmentType" } ], "description": "Indicates how employees are enrolled into the group.\n - `manual`: employees must be enrolled through an API.\n - `automatic`: employees are enrolled automatically upon being created with the Employer." }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Identifier for the `employer` that owns this `group`. Prefixed with `er_`.", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "object": { "type": "string", "description": "The object type", "readOnly": true }, "group_policy_ids": { "type": "array", "items": { "pattern": "gp_.+", "type": "string", "example": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "description": "Group policy unique identifiers associated with this group." }, "group_quote_intent_ids": { "type": "array", "items": { "pattern": "gqi_.+", "type": "string", "example": "gqi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "description": "Group quote intent unique identifiers associated with this group." }, "group_policy_intent_ids": { "type": "array", "items": { "pattern": "gpi_.+", "type": "string", "example": "gpi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "description": "Group policy intent unique identifiers associated with this group." } }, "additionalProperties": false }, "GroupResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GroupResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "GroupStatus": { "enum": [ "pending", "ready", "archived" ], "type": "string" }, "GroupStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/GroupStatus" } } }, "additionalProperties": false }, "GroupType": { "enum": [ "undefined", "single", "bundled" ], "type": "string" }, "GroupUpdatedV2Webhook": { "title": "GroupUpdatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "group.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/GroupEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "HealthInsuranceContributionCategory": { "enum": [ "gross_premium", "tax", "tax_relief" ], "type": "string" }, "HealthInsuranceContributionMemberType": { "enum": [ "policyholder", "partner_dependant", "child_dependant" ], "type": "string" }, "HealthInsuranceContributionType": { "enum": [ "recurring", "one_off" ], "type": "string" }, "HealthInsuranceCostSharingConfigurationResponse": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCostSharingType" } ], "description": "Cost sharing type. Determines which sub-object is populated." }, "member_count": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceMemberCountCostSharingConfigurationResponse" } ], "description": "Numbers of additional members covered by the employer." }, "member_selection": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceMemberSelectionCostSharingConfigurationResponse" } ], "description": "Whether specific member types are covered by the employer." }, "percentage": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePercentageCostSharingConfigurationResponse" } ], "description": "Percentage of the premium the employer covers." }, "family_type": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceFamilyTypeCostSharingConfigurationResponse" } ], "description": "Type of the family covered by the employer." } }, "additionalProperties": false }, "HealthInsuranceCostSharingType": { "enum": [ "member_count", "member_selection", "percentage", "policyholder_only", "family_type" ], "type": "string", "x-fern-enum": { "member_count": { "description": "The number of additional adults and children to cover is specified." }, "member_selection": { "description": "Dependent categories to cover are selected (partner and/or children)." }, "percentage": { "description": "A percentage of the total premium is covered." }, "policyholder_only": { "description": "Only the policyholder is covered." }, "family_type": { "description": "Coverage is based on a predefined family tier (e.g. Single, Couple, Family)." } } }, "HealthInsuranceCoverageLevelDocumentResponse": { "required": [ "link", "title" ], "type": "object", "properties": { "title": { "type": "string", "description": "Health Insurance Document Title" }, "link": { "type": "string", "description": "Health Insurance Document Link (can be a link to a website or a file path)" } }, "additionalProperties": false }, "HealthInsuranceCoverageLevelResponse": { "required": [ "documents", "plan_currency", "plan_id", "plan_name", "provider_logo_url", "provider_name" ], "type": "object", "properties": { "plan_id": { "pattern": "pl_.+", "type": "string", "description": "Unique identifier for the health insurance plan", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "plan_name": { "type": "string", "description": "Name of the health insurance plan" }, "plan_currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "Currency code of the health insurance plan" }, "provider_name": { "type": "string", "description": "Name of the health insurance provider" }, "provider_logo_url": { "type": "string", "description": "Logo URL of the health insurance provider" }, "provider_employer_platform_url": { "type": [ "null", "string" ], "description": "URL to the health insurance provider's website for Employer Management" }, "provider_support_phone": { "type": [ "null", "string" ], "description": "Support phone number to the health insurance provider's website for Employer Management" }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/HealthInsuranceCoverageLevelDocumentResponse" }, "description": "Documents related to the health insurance plan, these documents may change at renewal, this includes the documents like `Insurance Product Information Document`, `Hospital Lists`, `Table of Cover` etc" } }, "additionalProperties": false }, "HealthInsuranceEnrolmentIntentResponse": { "required": [ "configuration" ], "type": "object", "properties": { "configuration": { "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyConfigurationResponse" } ], "description": "How benefit costs will be shared between employer and employee." }, "coverage_options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageResponse" }, "description": "Available plan coverage options at the policy scope. Only present when the plan has policy-scoped coverage configurations." }, "coverage_selections": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageOptionSelectionResponse" }, "description": "Current coverage option selections. Populated when selections have been submitted." } }, "additionalProperties": false }, "HealthInsuranceEstimatedGrossPremiumResponse": { "required": [ "currency", "monthly", "term" ], "type": "object", "properties": { "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "Three-letter currency code (e.g., \"EUR\", \"USD\", \"GBP\") for all monetary amounts in this object." }, "monthly": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceGrossEstimationAmountResponse" } ], "description": "Estimated monthly gross premium amounts representing regular monthly charges." }, "term": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceGrossEstimationAmountResponse" } ], "description": "Estimated total gross premium amounts for the complete policy term from start date to renewal date. Note: These amounts reflect the full policy term and do not adjust for early cancellation." } }, "additionalProperties": false }, "HealthInsuranceFamilyCostSharingType": { "enum": [ "single", "couple", "single_with_children", "family" ], "type": "string" }, "HealthInsuranceFamilyTypeCostSharingConfigurationResponse": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceFamilyCostSharingType" } ], "description": "Employer coverage family type" } }, "additionalProperties": false }, "HealthInsuranceGrossEstimationAmountResponse": { "required": [ "employee_contribution", "employer_contribution", "total" ], "type": "object", "properties": { "employee_contribution": { "type": "number", "description": "Estimated gross premium amount deducted from employee payroll", "format": "double", "example": 123.45 }, "employer_contribution": { "type": "number", "description": "Estimated gross premium amount paid by the employer", "format": "double", "example": 123.45 }, "total": { "type": "number", "description": "Total gross premium amount (sum of employee and employer contributions).", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "HealthInsuranceGroupPolicyConfigurationResponse": { "required": [ "cost_sharing" ], "type": "object", "properties": { "cost_sharing": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCostSharingConfigurationResponse" } ], "description": "Defines how the policies total cost is shared between employer and employee." } }, "additionalProperties": false }, "HealthInsuranceGroupPolicyResponse": { "required": [ "configuration", "renewal" ], "type": "object", "properties": { "group_policy_number": { "type": [ "null", "string" ], "description": "Provider-issued policy number. May be null if not yet issued." }, "renewal": { "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyRenewalResponse" } ], "description": "Renewal information for the policy." }, "configuration": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceGroupPolicyConfigurationResponse" } ], "description": "How the policy is configured by default, such as cost sharing and other options." } }, "additionalProperties": false }, "HealthInsuranceMemberCountCostSharingConfigurationResponse": { "required": [ "adults", "children" ], "type": "object", "properties": { "adults": { "type": "integer", "description": "Number of additional adults covered, including partner/spouse.", "format": "int32", "example": 123 }, "children": { "type": "integer", "description": "Number of additional children covered.", "format": "int32", "example": 123 } }, "additionalProperties": false }, "HealthInsuranceMemberSelectionCostSharingConfigurationResponse": { "required": [ "children", "partner" ], "type": "object", "properties": { "partner": { "type": "boolean", "description": "If a spouse/partner is covered.", "example": true }, "children": { "type": "boolean", "description": "If children are covered.", "example": true } }, "additionalProperties": false }, "HealthInsurancePercentageCostSharingConfigurationResponse": { "required": [ "percentage" ], "type": "object", "properties": { "percentage": { "type": "integer", "description": "Employer coverage percentage:\n For 40% send 40.\n For 100% send 100.", "format": "int32", "example": 123 } }, "additionalProperties": false }, "HealthInsurancePolicyConfigurationResponse": { "required": [ "cost_sharing" ], "type": "object", "properties": { "cost_sharing": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceCostSharingConfigurationResponse" } ], "description": "Defines how the policy total cost is shared between employer and employee." } }, "additionalProperties": false }, "HealthInsurancePolicyEstimatedGrossPremiumResponse": { "required": [ "currency", "monthly", "term" ], "type": "object", "properties": { "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "Three-letter currency code (e.g., \"EUR\", \"USD\", \"GBP\") for all monetary amounts in this object." }, "monthly": { "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyGrossEstimationAmountResponse" } ], "description": "Estimated monthly gross premium amounts representing regular monthly charges." }, "term": { "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyGrossEstimationAmountResponse" } ], "description": "Estimated total gross premium amounts for the complete policy term from start date to renewal date. Note: These amounts reflect the full policy term and do not adjust for early cancellation." } }, "additionalProperties": false }, "HealthInsurancePolicyGrossEstimationAmountResponse": { "required": [ "employee_contribution", "employer_contribution", "total" ], "type": "object", "properties": { "employee_contribution": { "type": "number", "description": "Estimated gross premium amount deducted from employee payroll", "format": "double", "example": 123.45 }, "employer_contribution": { "type": "number", "description": "Estimated gross premium amount paid by the employer", "format": "double", "example": 123.45 }, "total": { "type": "number", "description": "Total gross premium amount (sum of employee and employer contributions).", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "HealthInsurancePolicyRenewalResponse": { "required": [ "renewal_date", "status", "window_end_date", "window_start_date" ], "type": "object", "properties": { "renewal_date": { "type": "string", "description": "Renewal date.", "format": "date", "example": "2024-12-01" }, "window_start_date": { "type": "string", "description": "Renewal window start (inclusive).", "format": "date", "example": "2024-12-01" }, "window_end_date": { "type": "string", "description": "Renewal window end (inclusive).", "format": "date", "example": "2024-12-01" }, "status": { "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyRenewalStatus" } ], "description": "Current renewal status." }, "renewed_policy_id": { "pattern": "p_.+", "type": [ "null", "string" ], "description": "Identifier of the renewed policy. This means existing policy will be replaced by the renewed policy on the renewal date.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "HealthInsurancePolicyRenewalStatus": { "enum": [ "upcoming", "open", "renewed", "cancelled" ], "type": "string" }, "HealthInsurancePolicyResponse": { "required": [ "configuration", "dependents_supported", "estimated_gross_premium", "initial_dependents_update_deadline", "members", "opt_out_deadline", "renewal" ], "type": "object", "properties": { "policy_number": { "type": [ "null", "string" ], "description": "Provider-issued policy number for health insurance" }, "opt_out_deadline": { "type": "string", "description": "Deadline for opting out of the policy. Members cannot opt out after this date.", "format": "date", "example": "2024-12-01" }, "initial_dependents_update_deadline": { "type": [ "null", "string" ], "description": "Represents the last date to add or remove dependents during the initial adjustment period. The deadline date is inclusive (changes are allowed on that date). This value should be evaluated using the local time zone where the policy is active. Returns null when the provider doesn't support dependent modifications during the initial adjustment period.", "format": "date", "example": "2024-12-01" }, "renewal": { "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyRenewalResponse" } ], "description": "Renewal information for the policy" }, "dependents_supported": { "type": "boolean", "description": "Whether this policy supports adding or removing dependents.", "example": true }, "configuration": { "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyConfigurationResponse" } ], "description": "How benefit costs are shared between employer and employee" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyMemberResponse" }, "description": "List of members on the health insurance policy" }, "estimated_gross_premium": { "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyEstimatedGrossPremiumResponse" } ], "description": "Estimated gross premium amounts for this health insurance policy based on current enrollment and policy configuration. Important: These estimates are for planning purposes only and may differ from actual billed amounts due to life events, policy changes, insurer billing practices, or timing adjustments. For accurate payroll amounts, use the Contribution Reporting API." } }, "additionalProperties": false }, "HealthInsuranceRequiredActionResponse": { "required": [ "code", "due_at", "reason", "reason_description" ], "type": "object", "properties": { "reason": { "type": "string", "description": "Concise reason for the required action" }, "reason_description": { "type": "string", "description": "Description for the required action" }, "code": { "type": "string", "description": "Identified the type of action required, not unique across health insurance providers" }, "due_at": { "type": "string", "description": "Date and time by which the action is due, if this is not completed then the policy will not be issued.", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "HealthInsuranceType": { "enum": [ "international", "local" ], "type": "string" }, "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "integer" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "additionalProperties": { } }, "IndicativePricingResponse": { "required": [ "adult_monthly_premium", "child_monthly_premium", "currency" ], "type": "object", "properties": { "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "Currency used for both average monthly guide prices." }, "adult_monthly_premium": { "type": "number", "description": "Average monthly guide price for an adult. The actual premium may be higher or lower based on the whole policy and this value must not be used in premium calculations.", "format": "double", "example": 123.45 }, "child_monthly_premium": { "type": "number", "description": "Average monthly guide price for a child. The actual premium may be higher or lower based on the whole policy and this value must not be used in premium calculations.", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "IndustryExclusionsDetails": { "required": [ "excluded_industries" ], "type": "object", "properties": { "excluded_industries": { "type": "array", "items": { "type": "string" }, "description": "List of excluded industries." } }, "additionalProperties": false }, "IntentActionType": { "enum": [ "provide_dependant_information", "provide_beneficiary_information", "provide_missing_information" ], "type": "string" }, "InvoiceCreatedV2Webhook": { "title": "InvoiceCreatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "invoice.created" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/InvoiceEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "InvoiceEventResponse": { "required": [ "id", "provider_id" ], "type": "object", "properties": { "id": { "pattern": "inv_.+", "type": "string", "description": "Identifier of the invoice associated with this event. Prefixed with `inv_`.", "example": "inv_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "provider_id": { "pattern": "pr_.+", "type": "string", "description": "Identifier of the provider that issued the invoice. Prefixed with `pr_`.", "example": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "InvoiceUpdatedV2Webhook": { "title": "InvoiceUpdatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "invoice.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/InvoiceEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "JsonNode": { "type": "object", "properties": { "options": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/JsonNodeOptions" } ], "readOnly": true }, "parent": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ], "readOnly": true }, "root": { "allOf": [ { "$ref": "#/components/schemas/JsonNode" } ], "readOnly": true } }, "additionalProperties": false }, "JsonNodeOptions": { "type": "object", "properties": { "property_name_case_insensitive": { "type": "boolean", "example": true } }, "additionalProperties": false }, "MemberType": { "enum": [ "policyholder", "spouse", "partner", "adult_dependant", "child" ], "type": "string" }, "MemberTypeCode": { "enum": [ "adult", "young_adult", "child" ], "type": "string" }, "MemberTypePricingResponse": { "required": [ "code", "display_name", "monthly_premium" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/MemberTypeCode" } ], "description": "Member type code." }, "display_name": { "type": "string", "description": "Display name for the member type." }, "monthly_premium": { "type": "number", "description": "Monthly premium amount.", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "MembersCountDetails": { "type": "object", "properties": { "min": { "type": [ "null", "integer" ], "description": "Minimum number of members required.", "format": "int32" }, "max": { "type": [ "null", "integer" ], "description": "Maximum number of members allowed.", "format": "int32" } }, "additionalProperties": false }, "OffboardEmployeeRequest": { "required": [ "offboard_on", "offboard_reason" ], "type": "object", "properties": { "offboard_on": { "type": "string", "description": "The date when the employee should be offboarded. Can be a future date, today, or up to 30 days in the past if the employee has active insurance policies. Past dates beyond 30 days are allowed only if there are no active policies.", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "offboard_reason": { "type": "string" } }, "additionalProperties": false }, "OrderDirection": { "enum": [ "asc", "desc" ], "type": "string" }, "OrderDirectionEnumParameter": { "enum": [ "asc", "desc" ], "type": "string", "additionalProperties": false }, "PayFrequency": { "enum": [ "annual", "monthly", "bi_weekly", "weekly" ], "type": "string" }, "PerMemberPricingResponse": { "required": [ "currency", "member_type_pricing" ], "type": "object", "properties": { "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "Currency code (e.g., 'eur', 'usd')." }, "member_type_pricing": { "type": "array", "items": { "$ref": "#/components/schemas/MemberTypePricingResponse" }, "description": "Pricing for each member type." } }, "additionalProperties": false }, "PlanCoverageOptionBenefitResponse": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Benefit name." }, "description": { "type": [ "null", "string" ], "description": "Benefit description." } }, "additionalProperties": false }, "PlanCoverageOptionInputType": { "enum": [ "single_select", "multi_select" ], "type": "string" }, "PlanCoverageOptionResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "pattern": "pco_.+", "type": "string", "description": "Unique identifier for this coverage option. Prefixed with `pco_`.", "example": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "Display name for this coverage option." }, "description": { "type": [ "null", "string" ], "description": "Longer explanation of this coverage option." }, "learn_more_url": { "type": [ "null", "string" ], "description": "Link to learn more about this coverage option." }, "from_price": { "type": [ "null", "number" ], "description": "Lowest applicable monthly price for this coverage option.", "format": "double" }, "benefits": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageOptionBenefitResponse" }, "description": "Benefit items included with this coverage option." }, "sub_options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageOptionResponse" }, "description": "Nested sub-options available when this option is selected." }, "eligibility_criteria": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/EmployerEligibilityCriterionResponse" }, "description": "Eligibility criteria that must be met to select this coverage option." } }, "additionalProperties": false }, "PlanCoverageOptionScope": { "enum": [ "group_policy", "policy", "member" ], "type": "string" }, "PlanCoverageOptionSelectionRequest": { "required": [ "configuration_id", "options" ], "type": "object", "properties": { "configuration_id": { "pattern": "pc_.+", "type": "string", "description": "Configuration ID (prefixed with `pc_`).", "example": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedOptionRequest" }, "description": "Selected options with optional sub-options." } }, "additionalProperties": false }, "PlanCoverageOptionSelectionResponse": { "required": [ "configuration_id", "options" ], "type": "object", "properties": { "configuration_id": { "pattern": "pc_.+", "type": "string", "description": "Configuration ID (prefixed with `pc_`).", "example": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/SelectedOptionResponse" }, "description": "Selected options." } }, "additionalProperties": false }, "PlanCoverageResponse": { "required": [ "id", "input_type", "name", "options", "required", "scope" ], "type": "object", "properties": { "id": { "pattern": "pc_.+", "type": "string", "description": "Unique identifier for the coverage selection. Prefixed with `pc_`.", "example": "pc_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "Title for this coverage selection. Typically used as the display heading." }, "description": { "type": [ "null", "string" ], "description": "Full description of this coverage selection." }, "scope": { "allOf": [ { "$ref": "#/components/schemas/PlanCoverageOptionScope" } ], "description": "Scope of selection for this coverage selection: `group_policy` (employer selects for the group), `policy` (per-policy selection), or `member` (individual member selects)." }, "input_type": { "allOf": [ { "$ref": "#/components/schemas/PlanCoverageOptionInputType" } ], "description": "Describes whether this input allows selecting a single option or multiple options." }, "required": { "type": "boolean", "description": "Whether a selection is mandatory.", "example": true }, "min_selections": { "type": [ "null", "integer" ], "description": "Minimum required selections (multi-select only).", "format": "int32" }, "max_selections": { "type": [ "null", "integer" ], "description": "Maximum allowed selections (multi-select only).", "format": "int32" }, "sort_order": { "type": [ "null", "integer" ], "description": "Display ordering hint.", "format": "int32" }, "group_label": { "type": [ "null", "string" ], "description": "Optional grouping label for UI rendering. Indicates which coverage selections are best presented together from a UX standpoint." }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/PlanCoverageOptionResponse" }, "description": "Available options within this coverage selection." } }, "additionalProperties": false }, "PlanDocumentResponse": { "required": [ "link", "title" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PlanDocumentType" } ], "description": "Machine-readable document kind used for display and i18n. Possible values are listed below; as this enum can expand with new benefits, unknown values MUST be handled gracefully by clients (fallback to a generic `document` label)." }, "title": { "type": "string", "description": "Title of the document." }, "link": { "type": "string", "description": "Public URL to the document. This could be any format (PDF, HTML, etc.)." } }, "additionalProperties": false }, "PlanDocumentType": { "enum": [ "ipid", "table_of_cover", "waiting_periods", "hospital_list", "plan_summary", "terms_and_conditions", "other" ], "type": "string" }, "PlanHealthInsuranceResponse": { "required": [ "health_insurance_type", "pricing", "supported_cost_sharing_options", "supported_member_types" ], "type": "object", "properties": { "health_insurance_type": { "allOf": [ { "$ref": "#/components/schemas/HealthInsuranceType" } ], "description": "Whether this is an international or local insurance plan." }, "supported_cost_sharing_options": { "type": "array", "items": { "$ref": "#/components/schemas/CostSharingOption" }, "description": "Cost sharing options supported by this plan." }, "supported_member_types": { "type": "array", "items": { "$ref": "#/components/schemas/MemberType" }, "description": "Member types supported by this plan." }, "pricing": { "allOf": [ { "$ref": "#/components/schemas/PlanPricingResponse" } ], "description": "Pricing information for the plan." } }, "additionalProperties": false }, "PlanPricingResponse": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PlanPricingType" } ], "description": "Type of pricing structure" }, "per_member": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PerMemberPricingResponse" } ], "description": "Per-member pricing details (populated when type is 'per_member')." }, "tier_based": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/TierBasedPricingResponse" } ], "description": "Tier-based pricing details (populated when type is 'tier_based')." } }, "additionalProperties": false }, "PlanPricingType": { "enum": [ "per_member", "tier_based" ], "type": "string" }, "PlanProviderResponse": { "required": [ "description", "id", "logo_url", "name" ], "type": "object", "properties": { "id": { "pattern": "pr_.+", "type": "string", "description": "Unique identifier for the provider. Prefixed with `pr_`.", "example": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "The name of the provider." }, "description": { "type": "string", "description": "Description of the provider." }, "logo_url": { "type": "string", "description": "URL to the provider's logo." } }, "additionalProperties": false }, "PlanResponse": { "required": [ "available_from", "country", "description", "disclosures", "documents", "employee_eligibility_criteria", "employer_eligibility_criteria", "id", "name", "provider", "type" ], "type": "object", "properties": { "object": { "type": "string", "description": "Object type. Always `plan`.", "readOnly": true }, "id": { "pattern": "pl_.+", "type": "string", "description": "Unique identifier for the plan. Prefixed with `pl_`.", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "allOf": [ { "$ref": "#/components/schemas/BenefitType" } ], "description": "The benefit type of the plan." }, "name": { "type": "string", "description": "The name of the plan." }, "description": { "type": "string", "description": "Description of the plan." }, "country": { "allOf": [ { "$ref": "#/components/schemas/CountryCode" } ], "description": "The country this plan is available in." }, "provider": { "allOf": [ { "$ref": "#/components/schemas/PlanProviderResponse" } ], "description": "The provider offering this plan." }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/PlanDocumentResponse" }, "description": "List of plan documents (e.g., IPIDs, T&Cs)." }, "employer_eligibility_criteria": { "type": "array", "items": { "$ref": "#/components/schemas/EmployerEligibilityCriterionResponse" }, "description": "Eligibility criteria that employers must meet." }, "employee_eligibility_criteria": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeEligibilityCriterionResponse" }, "description": "Eligibility criteria that employees must meet." }, "health_insurance": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PlanHealthInsuranceResponse" } ], "description": "Health insurance-specific details. Only populated when type is `health_insurance`." }, "indicative_pricing": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/IndicativePricingResponse" } ], "description": "Average monthly guide prices used when exact catalog pricing is unavailable. Actual premiums may be higher or lower based on the whole policy; these values are for comparison only and must not be used in premium calculations." }, "disclosures": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureResponse" }, "description": "Disclosures associated with this plan." }, "available_from": { "type": "string", "description": "The date from which this plan is available (inclusive).", "format": "date", "example": "2024-12-01" }, "available_to": { "type": [ "null", "string" ], "description": "The date until which this plan is available (inclusive). Null if the plan has no end date.", "format": "date", "example": "2024-12-01" }, "coverage_options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PlanCoverageResponse" }, "description": "Coverage options available for this plan, organized by scope and input type." }, "eligible_count": { "type": [ "null", "integer" ], "description": "Number of employees in the queried group eligible for this plan as-of `start_date`. Only present when both `group_id` and `start_date` query parameters are provided.", "format": "int32" }, "ineligible_count": { "type": [ "null", "integer" ], "description": "Number of employees in the queried group ineligible for this plan as-of `start_date`. Only present when both `group_id` and `start_date` query parameters are provided.", "format": "int32" }, "total_count": { "type": [ "null", "integer" ], "description": "Total employees in the queried group. Only present when both `group_id` and `start_date` query parameters are provided.", "format": "int32" } }, "additionalProperties": false }, "PlanResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PlanResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "PlanSortBy": { "enum": [ "premium" ], "type": "string" }, "PlanSortByEnumParameter": { "enum": [ "premium" ], "type": "string", "additionalProperties": false }, "PlanWithPricingResponse": { "required": [ "description", "id", "name", "pricing" ], "type": "object", "properties": { "id": { "pattern": "pl_.+", "type": "string", "description": "Unique identifier for the plan. Prefixed with `pl_`.", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "The name of the plan." }, "description": { "type": "string", "description": "Description of the plan." }, "pricing": { "allOf": [ { "$ref": "#/components/schemas/PlanPricingResponse" } ], "description": "Pricing information for the plan." } }, "additionalProperties": false }, "PolicyActiveV2Webhook": { "title": "PolicyActiveV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.active" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyAmendmentActionCode": { "enum": [ "provide_dependents_information" ], "type": "string", "x-fern-enum": { "provide_dependents_information": { "description": "Platform must provide information about dependents to be added/removed." } } }, "PolicyAmendmentAssociatedPersonsResponse": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/AssociatedPersonType" } ], "description": "The type of associated person." }, "dependents": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentDependentsResponse" } ], "description": "Dependents-specific information if type is 'dependents'." } }, "additionalProperties": false }, "PolicyAmendmentDependentsResponse": { "type": "object", "properties": { "dependents_management_intent_id": { "pattern": "dmi_.+", "type": [ "null", "string" ], "description": "Unique identifier for the dependents management intent. Prefixed with `dmi_`. Null if not yet created.", "example": "dmi_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/DependentsManagementIntentStatus" } ], "description": "The status of the dependents management process. Null if not yet started." } }, "additionalProperties": false }, "PolicyAmendmentIntentActionRequiredV2Webhook": { "title": "PolicyAmendmentIntentActionRequiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_amendment_intent.action_required" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyAmendmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyAmendmentIntentAmendedV2Webhook": { "title": "PolicyAmendmentIntentAmendedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_amendment_intent.amended" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyAmendmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyAmendmentIntentAwaitingQuoteV2Webhook": { "title": "PolicyAmendmentIntentAwaitingQuoteV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_amendment_intent.awaiting_quote" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyAmendmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyAmendmentIntentConfirmationCode": { "enum": [ "confirm_quote", "confirm_opt_out", "confirm_qle" ], "type": "string", "x-fern-enum": { "confirm_quote": { "description": "Platform must confirm the quote." }, "confirm_opt_out": { "description": "Platform must confirm the opt out from the policy." }, "confirm_qle": { "description": "Platform must confirm the Qualifying Life Event (QLE)." } } }, "PolicyAmendmentIntentEventResponse": { "required": [ "employee_id", "employer_id", "policy_amendment_intent_id", "policy_id" ], "type": "object", "properties": { "policy_amendment_intent_id": { "pattern": "pai_.+", "type": "string", "description": "Identifier of the policy amendment intent associated with this event. Prefixed with `pai_`.", "example": "pai_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "policy_id": { "pattern": "p_.+", "type": "string", "description": "Identifier of the policy associated with this policy amendment intent. Prefixed with `p_`.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Identifier of the employee associated with this policy amendment intent. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employer_id": { "pattern": "er_.+", "type": "string", "description": "Identifier of the employer associated with this policy amendment intent. Prefixed with `er_`.", "example": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "PolicyAmendmentIntentFailureCode": { "enum": [ "provider_rejected", "unable_to_quote" ], "type": "string", "x-fern-enum": { "provider_rejected": { "description": "The provider rejected the amendment request." }, "unable_to_quote": { "description": "We were unable to get a quote." } } }, "PolicyAmendmentIntentNotUndertakenV2Webhook": { "title": "PolicyAmendmentIntentNotUndertakenV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_amendment_intent.not_undertaken" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyAmendmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyAmendmentIntentPendingConfirmationV2Webhook": { "title": "PolicyAmendmentIntentPendingConfirmationV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_amendment_intent.pending_confirmation" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyAmendmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyAmendmentIntentProcessingErrorV2Webhook": { "title": "PolicyAmendmentIntentProcessingErrorV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_amendment_intent.processing_error" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyAmendmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyAmendmentIntentProcessingV2Webhook": { "title": "PolicyAmendmentIntentProcessingV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_amendment_intent.processing" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyAmendmentIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyAmendmentIntentResponse": { "required": [ "amendment_reason", "disclosures", "id", "policy_id", "requested_changes", "status" ], "type": "object", "properties": { "id": { "pattern": "pai_.+", "type": "string", "description": "Unique identifier for the policy amendment intent. Prefixed with `pai_`.", "example": "pai_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "object": { "type": "string", "description": "Object type identifier.", "readOnly": true }, "policy_id": { "pattern": "p_.+", "type": "string", "description": "The policy ID for which the amendment is requested. Prefixed with `p_`.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "status": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentIntentStatus" } ], "description": "Current status of the policy amendment intent." }, "amendment_reason": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentReasonResponse" } ], "description": "The reason for the policy amendment." }, "requested_changes": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyAmendmentRequestedChangeResponse" }, "description": "List of requested changes to the policy." }, "required_action": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentRequiredActionResponse" } ], "description": "Information about the required action if the intent status is `action_required`." }, "pending_confirmation": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentPendingConfirmationResponse" } ], "description": "Information about the pending confirmation if the intent status is `pending_confirmation`." }, "processing_error": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentProcessingErrorResponse" } ], "description": "Information about the processing error if the intent status is `processing_error`." }, "disclosures": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureResponse" }, "description": "Disclosures associated with this intent." } }, "additionalProperties": false }, "PolicyAmendmentIntentResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyAmendmentIntentResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "PolicyAmendmentIntentStatus": { "enum": [ "action_required", "awaiting_quote", "pending_confirmation", "processing", "amended", "processing_error", "not_undertaken" ], "type": "string", "x-fern-enum": { "action_required": { "description": "Amendment requires user action to proceed." }, "awaiting_quote": { "description": "Waiting for the provider to generate a quote for the requested amendment." }, "pending_confirmation": { "description": "Quote has been generated and is awaiting employee confirmation." }, "processing": { "description": "Changes are being applied to the policy by the provider." }, "amended": { "description": "Amendment successfully applied to the policy." }, "processing_error": { "description": "Amendment failed and cannot be retried (e.g. provider rejection)." }, "not_undertaken": { "description": "Amendment explicitly aborted or deadline expired." } } }, "PolicyAmendmentIntentStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyAmendmentIntentStatus" } } }, "additionalProperties": false }, "PolicyAmendmentPendingConfirmationResponse": { "required": [ "code", "due_by", "reason", "reason_description" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentIntentConfirmationCode" } ], "description": "The confirmation code indicating what confirmation is pending." }, "reason": { "type": "string", "description": "Brief reason for the pending confirmation." }, "reason_description": { "type": "string", "description": "Detailed description of the pending confirmation." }, "due_by": { "type": "string", "description": "The deadline by which the confirmation must be provided.", "format": "date", "example": "2024-12-01" }, "quote": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentQuoteResponse" } ], "description": "The quote details for the policy amendment." }, "associated_persons": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentAssociatedPersonsResponse" } ], "description": "Information about associated persons related to this pending confirmation." } }, "additionalProperties": false }, "PolicyAmendmentProcessingErrorResponse": { "required": [ "code", "reason", "reason_description" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentIntentFailureCode" } ], "description": "The error code indicating why processing failed." }, "reason": { "type": "string", "description": "Brief reason for the processing error." }, "reason_description": { "type": "string", "description": "Detailed description of the processing error." } }, "additionalProperties": false }, "PolicyAmendmentQualifyingLifeEventResponse": { "required": [ "event", "event_date" ], "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/QualifyingLifeEventType" } ], "description": "The type of qualifying life event." }, "event_date": { "type": "string", "description": "The date when the qualifying life event occurred.", "format": "date", "example": "2024-12-01" }, "reason": { "type": [ "null", "string" ], "description": "Additional reason or description for the qualifying life event." } }, "additionalProperties": false }, "PolicyAmendmentQuoteAmountResponse": { "required": [ "gross", "net", "tax" ], "type": "object", "properties": { "net": { "type": "number", "description": "Net amount before tax.", "format": "double", "example": 123.45 }, "tax": { "type": "number", "description": "Tax amount.", "format": "double", "example": 123.45 }, "gross": { "type": "number", "description": "Gross amount (net + tax).", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "PolicyAmendmentQuoteContributionsResponse": { "required": [ "employee_contribution", "employer_contribution", "total" ], "type": "object", "properties": { "employee_contribution": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentQuoteAmountResponse" } ], "description": "Employee contribution amounts." }, "employer_contribution": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentQuoteAmountResponse" } ], "description": "Employer contribution amounts." }, "total": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentQuoteAmountResponse" } ], "description": "Total contribution amounts (sum of employee and employer)." } }, "additionalProperties": false }, "PolicyAmendmentQuoteResponse": { "required": [ "currency", "monthly", "term" ], "type": "object", "properties": { "currency": { "type": "string", "description": "Three-letter currency code (e.g., \"EUR\", \"USD\", \"GBP\") for all monetary amounts in this quote." }, "monthly": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentQuoteContributionsResponse" } ], "description": "Monthly contribution breakdown for the policy amendment." }, "term": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentQuoteContributionsResponse" } ], "description": "Total term contribution breakdown for the policy amendment." } }, "additionalProperties": false }, "PolicyAmendmentReasonRequest": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/AmendmentReasonType" } ], "description": "The type of amendment reason." }, "qualifying_life_event": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/QualifyingLifeEventSupplementalInfo" } ], "description": "Supplemental information required for qualifying life event amendments." } }, "additionalProperties": false }, "PolicyAmendmentReasonResponse": { "required": [ "type" ], "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/AmendmentReasonType" } ], "description": "Unique identifier of the amendment reason type." }, "qualifying_life_event": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentQualifyingLifeEventResponse" } ], "description": "Details when `type` is `qualifying_life_event`." } }, "additionalProperties": false }, "PolicyAmendmentRequestedChangeRequest": { "required": [ "change_type" ], "type": "object", "properties": { "change_type": { "allOf": [ { "$ref": "#/components/schemas/RequestedChangeType" } ], "description": "The type of change requested." } }, "additionalProperties": false }, "PolicyAmendmentRequestedChangeResponse": { "required": [ "change_type" ], "type": "object", "properties": { "change_type": { "allOf": [ { "$ref": "#/components/schemas/RequestedChangeType" } ], "description": "The type of change requested." } }, "additionalProperties": false }, "PolicyAmendmentRequiredActionResponse": { "required": [ "associated_persons", "code", "due_by", "reason", "reason_description" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentActionCode" } ], "description": "The action code indicating what action is required." }, "reason": { "type": "string", "description": "Brief reason for the required action." }, "reason_description": { "type": "string", "description": "Detailed description of the required action." }, "due_by": { "type": "string", "description": "The deadline by which the action must be completed. The day is included (i.e. the action can be completed any time during this day in the user's local time).", "format": "date", "example": "2024-12-01" }, "associated_persons": { "allOf": [ { "$ref": "#/components/schemas/PolicyAmendmentAssociatedPersonsResponse" } ], "description": "Information about associated persons related to this action." } }, "additionalProperties": false }, "PolicyCancelledV2Webhook": { "title": "PolicyCancelledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.cancelled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyConfigurationRequest": { "type": "object", "properties": { "desired_policy_start_date": { "type": [ "null", "string" ], "description": "The desired date for the employee's policy to start. This date is not guaranteed to be honored by the insurance provider and may be adjusted based on provider-specific rules and requirements. If unspecified, the policy start date will be determined by the insurance provider.", "format": "date", "example": "2024-12-01" }, "enrolment_date": { "type": [ "null", "string" ], "description": "The date on which the employee agreed to enrol into the group's policies. This date may be used by some insurance providers to determine the policy start date. If unspecified, the enrolment date will default to the date the enrolment intent is processed.", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "PolicyConfigurationResponse": { "type": "object", "properties": { "desired_policy_start_date": { "type": [ "null", "string" ], "description": "Desired policy start date, not guaranteed to be honoured by the provider.", "format": "date", "example": "2024-12-01" }, "enrolment_date": { "type": [ "null", "string" ], "description": "The date on which the employee has agreed to enrol into a the group policy. This date may be used by some providers to determine policy start date.", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "PolicyEventResponse": { "required": [ "employee_id", "group_id", "group_policy_id", "policy_id" ], "type": "object", "properties": { "policy_id": { "pattern": "p_.+", "type": "string", "description": "Identifier of the policy associated with this event. Prefixed with `p_`.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Identifier of the employee associated with this policy. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_policy_id": { "pattern": "gp_.+", "type": "string", "description": "Identifier of the group policy id associated with this policy. Prefixed with `gp_`.", "example": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier of the group associated with this policy. Prefixed with `gr_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "PolicyExpiredV2Webhook": { "title": "PolicyExpiredV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.expired" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyImportIntentAssociatedPersonResponse": { "required": [ "associated_person_id", "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the associated person import.", "format": "uuid" }, "associated_person_id": { "pattern": "ap_.+", "type": "string", "description": "The associated person ID. Prefixed with `ap_`.", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "member_number": { "type": [ "null", "string" ], "description": "The member number assigned by the provider for this associated person." }, "start_date": { "type": [ "null", "string" ], "description": "The start date for this associated person's coverage.", "format": "date", "example": "2024-12-01" }, "end_date": { "type": [ "null", "string" ], "description": "The end date for this associated person's coverage.", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "PolicyImportIntentEventResponse": { "required": [ "employee_id", "group_id", "policy_import_intent_id" ], "type": "object", "properties": { "policy_import_intent_id": { "pattern": "pii_.+", "type": "string", "description": "Identifier of the policy import intent associated with this event. Prefixed with `pii_`.", "example": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Identifier of the employee associated with this policy import intent. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier of the group associated with this policy import intent. Prefixed with `g_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "policy_id": { "pattern": "p_.+", "type": [ "null", "string" ], "description": "Identifier of the policy created from this import intent. Prefixed with `p_`. Only present on success.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "PolicyImportIntentFailedV2Webhook": { "title": "PolicyImportIntentFailedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_import_intent.failed" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyImportIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyImportIntentProcessingV2Webhook": { "title": "PolicyImportIntentProcessingV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_import_intent.processing" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyImportIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyImportIntentResponse": { "required": [ "associated_persons", "employee_id", "group_id", "id", "member_number", "policy_start_date", "provider_policy_number", "status" ], "type": "object", "properties": { "id": { "pattern": "pii_.+", "type": "string", "description": "Unique identifier for the policy import intent. Prefixed with `pii_`.", "example": "pii_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "object": { "type": "string", "description": "Object type identifier.", "readOnly": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/PolicyImportIntentStatus" } ], "description": "Current status of the policy import intent." }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "The employee ID for the policy import. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "The group ID for the policy import. Prefixed with `g_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "provider_policy_number": { "type": "string", "description": "The provider's policy number." }, "member_number": { "type": "string", "description": "The member number assigned by the provider." }, "policy_start_date": { "type": "string", "description": "The start date of the policy.", "format": "date", "example": "2024-12-01" }, "policy_end_date": { "type": [ "null", "string" ], "description": "The end date of the policy. Null if the policy has no end date, or end date is not known.", "format": "date", "example": "2024-12-01" }, "associated_persons": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyImportIntentAssociatedPersonResponse" }, "description": "List of associated persons linked to this policy import." } }, "additionalProperties": false }, "PolicyImportIntentResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyImportIntentResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "PolicyImportIntentStatus": { "enum": [ "processing", "failed", "success" ], "type": "string", "x-fern-enum": { "processing": { "description": "The policy import is being processed." }, "failed": { "description": "The policy import has failed." }, "success": { "description": "The policy import has completed successfully." } } }, "PolicyImportIntentStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyImportIntentStatus" } } }, "additionalProperties": false }, "PolicyImportIntentSuccessV2Webhook": { "title": "PolicyImportIntentSuccessV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy_import_intent.success" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyImportIntentEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyImportedV2Webhook": { "title": "PolicyImportedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.imported" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyMemberResponse": { "required": [ "date_of_birth", "first_name", "id", "last_name", "member_type", "sex_at_birth" ], "type": "object", "properties": { "id": { "pattern": "pm_.+", "type": "string", "description": "Unique identifier for the policy member. Prefixed with `pm_`.", "example": "pm_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "member_number": { "type": [ "null", "string" ], "description": "Provider-issued member number, null if not issues yet" }, "first_name": { "type": "string", "description": "First name of the member" }, "last_name": { "type": "string", "description": "Last name of the member" }, "date_of_birth": { "type": "string", "description": "Date of birth of the member", "format": "date", "example": "2024-12-01" }, "sex_at_birth": { "allOf": [ { "$ref": "#/components/schemas/SexAtBirth" } ], "description": "Sex at birth of the member" }, "member_type": { "allOf": [ { "$ref": "#/components/schemas/MemberType" } ], "description": "Type of the policy member" }, "associated_person_id": { "pattern": "ap_.+", "type": [ "null", "string" ], "description": "Identifier of the associated person. Not present for policyholders. Prefixed with `ap_`.", "example": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "PolicyPlanResponse": { "required": [ "currency", "description", "documents", "id", "name" ], "type": "object", "properties": { "id": { "pattern": "pl_.+", "type": "string", "description": "Unique identifier for the plan. Prefixed with pl_.", "example": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "Plan display name." }, "description": { "type": "string", "description": "Short description of the plan." }, "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "ISO 4217 currency code for pricing under this plan." }, "documents": { "type": "array", "items": { "$ref": "#/components/schemas/PlanDocumentResponse" }, "description": "List of plan documents (e.g., IPIDs, T&Cs)." } }, "additionalProperties": false }, "PolicyProviderResponse": { "required": [ "description", "id", "logo_url", "name" ], "type": "object", "properties": { "id": { "pattern": "pr_.+", "type": "string", "description": "Unique identifier for the provider. Prefixed with pr_.", "example": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "Provider display name." }, "description": { "type": "string", "description": "Short description of the provider." }, "logo_url": { "type": "string", "description": "" }, "employer_portal_url": { "type": [ "null", "string" ], "description": "URL for the employer portal." }, "employee_portal_url": { "type": [ "null", "string" ], "description": "URL for the employee portal (may include claims management)." }, "support_phone_number": { "type": [ "null", "string" ], "description": "Provider support phone number in E.164 format." } }, "additionalProperties": false }, "PolicyReference": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "p_.+", "type": "string", "description": "Unique identifier for the policy.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" } }, "additionalProperties": false }, "PolicyRenewalCanceledV2Webhook": { "title": "PolicyRenewalCanceledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.renewal.canceled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyRenewalOpenedV2Webhook": { "title": "PolicyRenewalOpenedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.renewal.opened" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyRenewalRenewedV2Webhook": { "title": "PolicyRenewalRenewedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.renewal.renewed" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyResponse": { "required": [ "bundling_type", "disclosures", "employee_id", "group_id", "group_policy_id", "id", "plan", "provider", "start_date", "status", "type" ], "type": "object", "properties": { "id": { "pattern": "p_.+", "type": "string", "description": "Unique identifier for the policy. Prefixed with `p_`.", "example": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Identifier of the employee associated with this policy. Prefixed with `ee_`.", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "group_policy_id": { "pattern": "gp_.+", "type": "string", "description": "Identifier of the group policy id associated with this policy. Prefixed with `gp_`.", "example": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "bundling_type": { "allOf": [ { "$ref": "#/components/schemas/BundlingType" } ], "description": "Indicates how this policy is bundled within a group" }, "status": { "allOf": [ { "$ref": "#/components/schemas/PolicyStatus" } ], "description": "Current lifecycle state of the policy" }, "group_id": { "pattern": "gr_.+", "type": "string", "description": "Identifier of the group associated with this policy. Prefixed with `gr_`.", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "provider": { "allOf": [ { "$ref": "#/components/schemas/PolicyProviderResponse" } ], "description": "Provider information for this policy" }, "plan": { "allOf": [ { "$ref": "#/components/schemas/PolicyPlanResponse" } ], "description": "Plan information for this policy" }, "start_date": { "type": "string", "description": "Policy start (effective) date in ISO 8601 (YYYY-MM-DD)", "format": "date", "example": "2024-12-01" }, "end_date": { "type": [ "null", "string" ], "description": "Policy end date (inclusive) in ISO 8601, or null if open-ended", "format": "date", "example": "2024-12-01" }, "cancellation_date": { "type": [ "null", "string" ], "description": "Date the policy was cancelled (if applicable)", "format": "date", "example": "2024-12-01" }, "opted_out_at": { "type": [ "null", "string" ], "description": "UTC timestamp of the moment the member opted out of this policy during the cooling-off window. Null when the policy is still running, and null when it ended any other way — an administrator cancelling it, the employee being offboarded, or the term expiring — even though those also set `cancellation_date`. Providers that only record the calendar day of an opt-out report midnight UTC.", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "type": { "allOf": [ { "$ref": "#/components/schemas/PolicyType" } ], "description": "Policy type. Determines which sub-object is populated." }, "health_insurance": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/HealthInsurancePolicyResponse" } ], "description": "Health insurance–specific fields (present when `type=health_insurance`)" }, "disclosures": { "type": "array", "items": { "$ref": "#/components/schemas/DisclosureResponse" }, "description": "Disclosures associated with this policy." }, "object": { "type": "string", "description": "Object type", "readOnly": true } }, "additionalProperties": false }, "PolicyResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "PolicyScheduledV2Webhook": { "title": "PolicyScheduledV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.scheduled" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PolicyStatus": { "enum": [ "scheduled", "active", "expired", "cancelled" ], "type": "string" }, "PolicyStatusMultiValueParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyStatus" } } }, "additionalProperties": false }, "PolicyType": { "enum": [ "health_insurance", "life_assurance" ], "type": "string" }, "PolicyUpdatedV2Webhook": { "title": "PolicyUpdatedV2Webhook", "required": [ "id", "type", "platform_id", "data", "created_at", "object", "version" ], "type": "object", "properties": { "id": { "pattern": "evt_*", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "type": { "type": "string", "example": "policy.updated" }, "platform_id": { "pattern": "pt_*", "type": "string", "example": "pt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "data": { "$ref": "#/components/schemas/PolicyEventResponse" }, "created_at": { "type": "string", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "example": "event" }, "version": { "type": "string", "example": "V2" } } }, "PricingTierResponse": { "required": [ "annual_premium", "code", "display_dependent_requirements", "display_name", "monthly_premium" ], "type": "object", "properties": { "code": { "allOf": [ { "$ref": "#/components/schemas/FamilyTierCode" } ], "description": "Tier code." }, "display_name": { "type": "string", "description": "Display name for the tier." }, "monthly_premium": { "type": "number", "description": "Monthly premium amount for this tier.", "format": "double", "example": 123.45 }, "annual_premium": { "type": "number", "description": "Annual premium amount for this tier.", "format": "double", "example": 123.45 }, "display_dependent_requirements": { "type": "string", "description": "Description of dependent requirements for this tier." } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "integer" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } }, "additionalProperties": { } }, "ProviderIdMultiValueIdParameter": { "type": "object", "properties": { "values": { "type": "array", "items": { "pattern": "pr_.+", "type": "string", "example": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a" } } }, "additionalProperties": false }, "ProviderResponse": { "required": [ "description", "id", "logo_url", "name", "support_phone", "supported_countries", "website_url" ], "type": "object", "properties": { "object": { "type": "string", "description": "Object type. Always `provider`.", "readOnly": true }, "id": { "pattern": "pr_.+", "type": "string", "description": "Unique identifier for the provider. Prefixed with `pr_`.", "example": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "name": { "type": "string", "description": "The name of the provider." }, "description": { "type": "string", "description": "Description of the provider." }, "website_url": { "type": "string", "description": "The provider's main website URL." }, "logo_url": { "type": "string", "description": "URL to the provider's logo image." }, "employer_platform_url": { "type": [ "null", "string" ], "description": "URL to the employer portal/platform for this provider, if available." }, "kota_hub_url": { "type": [ "null", "string" ], "description": "URL to the Kota Hub page for this platform, if configured." }, "support_phone": { "type": "string", "description": "Customer support phone number." }, "supported_countries": { "type": "array", "items": { "$ref": "#/components/schemas/CountryCode" }, "description": "List of countries supported by this provider." } }, "additionalProperties": false }, "ProviderResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "QualifyingLifeEventSupplementalInfo": { "required": [ "event", "event_date" ], "type": "object", "properties": { "event": { "allOf": [ { "$ref": "#/components/schemas/QualifyingLifeEventType" } ], "description": "The type of qualifying life event requested." }, "event_date": { "type": "string", "description": "The date at which the event occured. Note: This date must be within provider guidelines, where the date is outside of those guidelines the amendment may be rejected or the effective date of the change could be amended by the provider.", "format": "date", "example": "2024-12-01" }, "reason": { "type": [ "null", "string" ], "description": "A free text reason of the qualifying life event. Note: This will be shared with the insurance provider in lieu of `event` when its set to `other_change`." } }, "additionalProperties": false }, "QualifyingLifeEventType": { "enum": [ "gained_other_insurance_coverage", "divorce_or_legal_separation", "death_of_spouse_or_dependent", "moved_out_of_coverage_area", "employment_status_change_affecting_eligibility", "eligible_for_government_program", "marriage_or_civil_partnership", "birth_of_child", "adoption_of_child", "gained_legal_guardianship", "dependent_lost_other_coverage", "lost_legal_guardianship", "dependent_gained_other_coverage", "dependent_eligible_for_government_program", "dependent_aged_out", "dependent_student_status_change_affecting_eligibility", "dependent_moved_in_or_out_of_coverage_area", "other_change" ], "type": "string", "x-fern-enum": { "gained_other_insurance_coverage": { "description": "Employee gains alternative qualifying coverage (e.g. added to spouse's plan)." }, "divorce_or_legal_separation": { "description": "Marriage or civil partnership ends." }, "death_of_spouse_or_dependent": { "description": "A covered spouse or dependent dies." }, "moved_out_of_coverage_area": { "description": "Employee relocates to a country or region where this policy or insurer cannot provide coverage." }, "employment_status_change_affecting_eligibility": { "description": "Employee remains employed but moves to a role or status that is no longer eligible for this benefit." }, "eligible_for_government_program": { "description": "Employee becomes eligible for a statutory or national health program." }, "marriage_or_civil_partnership": { "description": "Employee gets married or enters a civil partnership. In some countries or providers, this is also valid if cohabiting." }, "birth_of_child": { "description": "A child is born." }, "adoption_of_child": { "description": "A child is adopted." }, "gained_legal_guardianship": { "description": "Employee becomes the legal guardian of a child or other dependent." }, "dependent_lost_other_coverage": { "description": "Dependent loses existing health insurance coverage (e.g. aging off parents' plan, losing employer/university/government coverage)." }, "lost_legal_guardianship": { "description": "Employee is no longer the legal guardian of a dependent." }, "dependent_gained_other_coverage": { "description": "Dependent gains their own qualifying coverage (e.g. their own employer plan)." }, "dependent_eligible_for_government_program": { "description": "Dependent becomes eligible for a statutory or national health program." }, "dependent_aged_out": { "description": "Dependent reaches the maximum age allowed under the policy." }, "dependent_student_status_change_affecting_eligibility": { "description": "Dependent becomes or stops being an eligible student." }, "dependent_moved_in_or_out_of_coverage_area": { "description": "Dependent moves into or out of a covered region." }, "other_change": { "description": "Other life event not covered by specific categories." } } }, "RelationshipType": { "enum": [ "spouse", "partner", "child", "other" ], "type": "string" }, "ReplayDeliveryResponse": { "required": [ "delivery_id", "elapsed_time_ms", "response_status_code", "success" ], "type": "object", "properties": { "delivery_id": { "pattern": "evtd_.+", "type": "string", "example": "evtd_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "success": { "type": "boolean", "example": true }, "response_status_code": { "type": [ "null", "integer" ], "format": "int32" }, "elapsed_time_ms": { "type": "number", "format": "double", "example": 123.45 } }, "additionalProperties": false }, "ReplayEventResponse": { "required": [ "deliveries", "event_id" ], "type": "object", "properties": { "event_id": { "pattern": "evt_.+", "type": "string", "example": "evt_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/ReplayDeliveryResponse" } } }, "additionalProperties": false }, "RequestedChangeType": { "enum": [ "dependents", "cancellation" ], "type": "string", "x-fern-enum": { "dependents": { "description": "Request to add or remove dependents from the policy." }, "cancellation": { "description": "Request to cancel the policy." } } }, "RequirementObjectType": { "enum": [ "employee", "employer", "associated_person" ], "type": "string" }, "RequirementObjectTypeEnumParameter": { "enum": [ "employee", "employer", "associated_person" ], "type": "string", "additionalProperties": false }, "RequirementType": { "enum": [ "group_quote_intent", "group_policy_intent", "dependent_management_intent", "policy_amendment_intent", "enrolment_intent" ], "type": "string" }, "SalaryEventResponse": { "required": [ "employee_id", "id" ], "type": "object", "properties": { "id": { "pattern": "sal_.+", "type": "string", "description": "Unique identifier for the salary record", "example": "sal_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee this salary belongs to", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "resource_type": { "type": "string", "description": "Resource type, the underlying resource this event is related to.", "readOnly": true }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "SalaryResponse": { "required": [ "amount", "currency", "effective_from", "employee_id", "id", "pay_frequency" ], "type": "object", "properties": { "id": { "pattern": "sal_.+", "type": "string", "description": "Unique identifier for the salary record", "example": "sal_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "employee_id": { "pattern": "ee_.+", "type": "string", "description": "Unique identifier for the employee this salary belongs to", "example": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "amount": { "type": "number", "description": "Salary amount, in the given currency and pay frequency", "format": "double", "example": 123.45 }, "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "ISO currency code the amount is denominated in" }, "pay_frequency": { "allOf": [ { "$ref": "#/components/schemas/PayFrequency" } ], "description": "The period this amount represents (e.g. annual, monthly)" }, "effective_from": { "type": "string", "description": "Date from which this salary is effective", "format": "date", "example": "2024-12-01" }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "SalaryResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SalaryResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "ScheduledGroupTransitionResponse": { "required": [ "new_group_id", "scheduled_date" ], "type": "object", "properties": { "new_group_id": { "pattern": "gr_.+", "type": "string", "description": "Unique identifier for the group the employee will be moved to", "example": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "scheduled_date": { "type": "string", "description": "The date when the employee will be moved to the new group", "format": "date", "example": "2024-12-01" } }, "additionalProperties": false }, "SelectedOptionRequest": { "required": [ "option_id" ], "type": "object", "properties": { "option_id": { "pattern": "pco_.+", "type": "string", "description": "Option ID (prefixed with `pco_`).", "example": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "sub_options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SelectedOptionRequest" }, "description": "Sub-option selections, if applicable." } }, "additionalProperties": false }, "SelectedOptionResponse": { "required": [ "option_id" ], "type": "object", "properties": { "option_id": { "pattern": "pco_.+", "type": "string", "description": "Option ID (prefixed with `pco_`).", "example": "pco_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "sub_options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SelectedOptionResponse" }, "description": "Selected sub-options, if applicable." } }, "additionalProperties": false }, "SexAtBirth": { "enum": [ "male", "female" ], "type": "string" }, "SortDirection": { "enum": [ "asc", "desc" ], "type": "string" }, "SortDirectionEnumParameter": { "enum": [ "asc", "desc" ], "type": "string", "additionalProperties": false }, "SubmitCoverageSelectionsRequest": { "required": [ "coverage_selections" ], "type": "object", "properties": { "coverage_selections": { "type": "array", "items": { "$ref": "#/components/schemas/PlanCoverageOptionSelectionRequest" }, "description": "Coverage option selections for policy-scoped configurations." } }, "additionalProperties": false }, "TierBasedPricingResponse": { "required": [ "currency", "tiers" ], "type": "object", "properties": { "currency": { "allOf": [ { "$ref": "#/components/schemas/CurrencyCode" } ], "description": "Currency code (e.g., 'eur', 'usd')." }, "tiers": { "type": "array", "items": { "$ref": "#/components/schemas/PricingTierResponse" }, "description": "Pricing tiers for different family compositions." } }, "additionalProperties": false }, "UpdateAssociatedPersonRequest": { "type": "object", "properties": { "first_name": { "type": [ "null", "string" ], "description": "NOTE: This field will be normalized according to our internal formatting rules." }, "last_name": { "type": [ "null", "string" ], "description": "NOTE: This field will be normalized according to our internal formatting rules." }, "date_of_birth": { "type": [ "null", "string" ], "description": "Must be in the past, but after 1900-01-01", "format": "date", "example": "2024-12-01" }, "sex_at_birth": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/SexAtBirth" } ], "description": "The sex assigned to the associated person at birth" }, "relationship_type": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/RelationshipType" } ], "description": "The relationship type between the employee and the associated person" }, "email": { "type": [ "null", "string" ], "description": "Email address of the associated person. If null is provided, the email will be cleared. NOTE: This field will be normalized according to our internal formatting rules." }, "phone_number": { "type": [ "null", "string" ], "description": "Phone number in E.164 international format (e.g. +447700900999). If null is provided, the phone number will be cleared. NOTE: This field will be normalized according to our internal formatting rules." } }, "additionalProperties": false }, "UpdateEmployeeRequest": { "type": "object", "properties": { "first_name": { "type": [ "null", "string" ] }, "last_name": { "type": [ "null", "string" ] }, "home_address": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/AddressModelWithoutCountry" } ], "description": "Treated as a single object that is updated entirely, `null` sub-fields (e.g. Line 3) will delete the existing values" }, "nationality": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CountryCode" } ] }, "national_tax_id": { "type": [ "null", "string" ], "description": "National tax ID, e.g. PPSN in Ireland, NINO in the UK, DNI/NIE in Spain" }, "phone_number": { "type": [ "null", "string" ], "description": "Phone number in E.164 international format (e.g. +447700900999)" }, "email": { "type": [ "null", "string" ] }, "start_on": { "type": [ "null", "string" ], "description": "The start date of the employee.\n\n**Constraints:**\n\n- On update, may only be changed if no policy or offer exists for this employee.\n- Must be a valid date.\n- The employee's existing start_on and the new start_on date must both be in the future.", "format": "date", "example": "2024-12-01" }, "earliest_benefits_start_date": { "type": [ "null", "string" ], "description": "The earliest date this employee can be enrolled in any benefits. Before this date, the employee remains in a Pending state and is excluded from benefit activation.\n\n**Constraints:**\n\n- On update, may only be changed if no policy or offer exists for this employee.\n- Must be a valid date.\n- Ignored for statutory schemes where immediate coverage is legally required. Example: Local Netherlands and UAE schemes.", "format": "date", "example": "2024-12-01" }, "bank_account": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/CreateEmployeeBankAccount" } ], "description": "Treated as a single object that is updated entirely." }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters. Treated as a single object that is updated entirely." } }, "additionalProperties": false }, "UpdateEmployerRequest": { "type": "object", "properties": { "legal_name": { "type": [ "null", "string" ] }, "registration_number": { "type": [ "null", "string" ] }, "legal_address": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/AddressModelWithoutCountry" } ], "description": "Treated as a single object that is updated entirely, `null` sub-fields (e.g. Line 3) will delete the existing values" }, "contact": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/ContactModel" } ] }, "earliest_benefits_start_date": { "type": [ "null", "string" ], "description": "The earliest date this employer is permitted to set up any benefits scheme. If this date is in the future, benefit setup will be blocked until then. Used to delay scheme setup access (e.g., for onboarding alignment).\n\n**Constraints:**\n\n- Can only be set or updated if no group policy or group quote exists.\n- Must be a valid date.", "format": "date", "example": "2024-12-01" }, "metadata": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Maximum 25 keys. Individual keys can be up to 40 characters and values up to 500 characters. Treated as a single object that is updated entirely." } }, "additionalProperties": false }, "UpdateGroupRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Human-readable name of the `group`." }, "description": { "type": [ "null", "string" ], "description": "Short description of the purpose or scope of the `group`." } }, "additionalProperties": false }, "WebhookEndpointResponse": { "required": [ "created_at", "endpoint_url", "id", "subscribed_events" ], "type": "object", "properties": { "id": { "pattern": "whe_.+", "type": "string", "description": "The unique identifier of the endpoint", "example": "whe_3b1333d87d9d4fd6ad83ba7f6b0e951a" }, "endpoint_url": { "type": "string", "description": "The registered URL of the endpoint" }, "subscribed_events": { "type": "array", "items": { "type": "string" }, "description": "The events the endpoint is subscribed to" }, "created_at": { "type": "string", "description": "The date and time the endpoint was created", "format": "date-time", "example": "2024-12-01T00:00:00Z" }, "object": { "type": "string", "description": "The object type", "readOnly": true } }, "additionalProperties": false }, "WebhookEndpointResponsePagedList": { "required": [ "items", "page", "page_size", "total_count" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpointResponse" }, "description": "A paginated array containing the response elements" }, "page": { "type": "integer", "description": "The current page of the results", "format": "int32", "example": 123 }, "page_size": { "type": "integer", "description": "The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size", "format": "int32", "example": 123 }, "total_count": { "type": "integer", "description": "The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.", "format": "int32", "example": 123 }, "has_next_page": { "type": "boolean", "description": "Whether there are more pages available after this page", "readOnly": true, "example": true }, "has_previous_page": { "type": "boolean", "description": "Whether there are more pages available before this page", "readOnly": true, "example": true } }, "additionalProperties": false }, "WebhookVersion": { "enum": [ "v1", "v2" ], "type": "string" }, "WebhookVersionEnumParameter": { "enum": [ "v1", "v2" ], "type": "string", "additionalProperties": false } }, "securitySchemes": { "bearerAuth": { "type": "http", "description": "Authorization header using the Bearer scheme", "scheme": "bearer", "x-fern-bearer": { "name": "apiKey", "env": "KOTA_API_KEY" } } } }, "security": [ { "bearerAuth": [ ] } ], "tags": [ { "name": "Associated Persons" }, { "name": "Contribution Reports" }, { "name": "Dependents Management Intents" }, { "name": "Embed Sessions" }, { "name": "Employees" }, { "name": "Employers" }, { "name": "Enrolment Intents" }, { "name": "Events" }, { "name": "Group Policies" }, { "name": "Group Policy Intents" }, { "name": "Group Quote Intents" }, { "name": "Groups" }, { "name": "Health Insurance" }, { "name": "Hosted Sessions" }, { "name": "Plans" }, { "name": "Policies" }, { "name": "Policy Amendment Intents" }, { "name": "Policy Import Intents" }, { "name": "Providers" }, { "name": "Salaries" }, { "name": "Webhooks" } ], "webhooks": { "EmployeeCreatedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employee.created", "operationId": "EmployeeCreatedWebhook", "requestBody": { "description": "An employee was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeCreatedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeCreatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.created", "operationId": "EmployeeCreatedV2Webhook", "requestBody": { "description": "An employee was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeCreatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeUpdatedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employee.updated", "operationId": "EmployeeUpdatedWebhook", "requestBody": { "description": "An employee was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeUpdatedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeUpdatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.updated", "operationId": "EmployeeUpdatedV2Webhook", "requestBody": { "description": "An employee was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeUpdatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeOffboardedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employee.offboarded", "operationId": "EmployeeOffboardedWebhook", "requestBody": { "description": "An employee was offboarded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeOffboardedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeOffboardedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.offboarded", "operationId": "EmployeeOffboardedV2Webhook", "requestBody": { "description": "An employee was offboarded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeOffboardedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerCreatedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.created", "operationId": "EmployerCreatedWebhook", "requestBody": { "description": "An employer was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerCreatedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerCreatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.created", "operationId": "EmployerCreatedV2Webhook", "requestBody": { "description": "An employer was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerCreatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerUpdatedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.updated", "operationId": "EmployerUpdatedWebhook", "requestBody": { "description": "An employer was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerUpdatedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerUpdatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.updated", "operationId": "EmployerUpdatedV2Webhook", "requestBody": { "description": "An employer was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerUpdatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerOffboardedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.offboarded", "operationId": "EmployerOffboardedWebhook", "requestBody": { "description": "An employer was offboarded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerOffboardedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerOffboardedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.offboarded", "operationId": "EmployerOffboardedV2Webhook", "requestBody": { "description": "An employer was offboarded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerOffboardedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuoteCreatedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.health_insurance.quote.created", "operationId": "EmployerHealthInsuranceQuoteCreatedWebhook", "requestBody": { "description": "A group health insurance quote request was created for an employer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteCreatedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuoteCreatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.health_insurance.quote.created", "operationId": "EmployerHealthInsuranceQuoteCreatedV2Webhook", "requestBody": { "description": "A group health insurance quote request was created for an employer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteCreatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuoteActionRequiredWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.health_insurance.quote.action_required", "operationId": "EmployerHealthInsuranceQuoteActionRequiredWebhook", "requestBody": { "description": "A group health insurance quote requires an action from the employer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteActionRequiredWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuoteActionRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.health_insurance.quote.action_required", "operationId": "EmployerHealthInsuranceQuoteActionRequiredV2Webhook", "requestBody": { "description": "A group health insurance quote requires an action from the employer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteActionRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuoteNotUndertakenWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.health_insurance.quote.not_undertaken", "operationId": "EmployerHealthInsuranceQuoteNotUndertakenWebhook", "requestBody": { "description": "A group health insurance quote was not taken out", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteNotUndertakenWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuoteNotUndertakenV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.health_insurance.quote.not_undertaken", "operationId": "EmployerHealthInsuranceQuoteNotUndertakenV2Webhook", "requestBody": { "description": "A group health insurance quote was not taken out", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteNotUndertakenV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuoteAcceptedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.health_insurance.quote.accepted", "operationId": "EmployerHealthInsuranceQuoteAcceptedWebhook", "requestBody": { "description": "A group health insurance quote was accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteAcceptedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuoteAcceptedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.health_insurance.quote.accepted", "operationId": "EmployerHealthInsuranceQuoteAcceptedV2Webhook", "requestBody": { "description": "A group health insurance quote was accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuoteAcceptedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuotePendingWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.health_insurance.quote.pending_quote", "operationId": "EmployerHealthInsuranceQuotePendingWebhook", "requestBody": { "description": "A group health insurance request for quote was made", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuotePendingWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuotePendingV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.health_insurance.quote.pending_quote", "operationId": "EmployerHealthInsuranceQuotePendingV2Webhook", "requestBody": { "description": "A group health insurance request for quote was made", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuotePendingV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employer.health_insurance.quote.pending_insurer_acceptance", "operationId": "EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook", "requestBody": { "description": "A group health insurance quote is now pending acceptance by the insurer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuotePendingInsurerAcceptanceWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployerHealthInsuranceQuotePendingInsurerAcceptanceV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employer.health_insurance.quote.pending_insurer_acceptance", "operationId": "EmployerHealthInsuranceQuotePendingInsurerAcceptanceV2Webhook", "requestBody": { "description": "A group health insurance quote is now pending acceptance by the insurer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployerHealthInsuranceQuotePendingInsurerAcceptanceV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsuranceOfferActionRequiredWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employee.health_insurance.offer.action_required", "operationId": "EmployeeHealthInsuranceOfferActionRequiredWebhook", "requestBody": { "description": "A health insurance offer requires action from an employee.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsuranceOfferActionRequiredWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsuranceOfferActionRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.health_insurance.offer.action_required", "operationId": "EmployeeHealthInsuranceOfferActionRequiredV2Webhook", "requestBody": { "description": "A health insurance offer requires action from an employee.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsuranceOfferActionRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsurancePolicyActivatedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employee.health_insurance.policy.activated", "operationId": "EmployeeHealthInsurancePolicyActivatedWebhook", "requestBody": { "description": "An Employee health insurance policy is successfully activated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyActivatedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsurancePolicyActivatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.health_insurance.policy.activated", "operationId": "EmployeeHealthInsurancePolicyActivatedV2Webhook", "requestBody": { "description": "An Employee health insurance policy is successfully activated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyActivatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsurancePolicyCancelledWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employee.health_insurance.policy.cancelled", "operationId": "EmployeeHealthInsurancePolicyCancelledWebhook", "requestBody": { "description": "An Employee health insurance policy is successfully cancelled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyCancelledWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsurancePolicyCancelledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.health_insurance.policy.cancelled", "operationId": "EmployeeHealthInsurancePolicyCancelledV2Webhook", "requestBody": { "description": "An Employee health insurance policy is successfully cancelled.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyCancelledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsurancePolicyExpiredWebhook": { "post": { "tags": [ "Types of events" ], "summary": "employee.health_insurance.policy.expired", "operationId": "EmployeeHealthInsurancePolicyExpiredWebhook", "requestBody": { "description": "An Employee health insurance policy is expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyExpiredWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsurancePolicyExpiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.health_insurance.policy.expired", "operationId": "EmployeeHealthInsurancePolicyExpiredV2Webhook", "requestBody": { "description": "An Employee health insurance policy is expired.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyExpiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeHealthInsurancePolicyImportedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.health_insurance.policy.imported", "operationId": "EmployeeHealthInsurancePolicyImportedV2Webhook", "requestBody": { "description": "An Employee health insurance policy was imported from an external system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeHealthInsurancePolicyImportedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "ContributionReportFinalizedWebhook": { "post": { "tags": [ "Types of events" ], "summary": "contribution_report.finalized", "operationId": "ContributionReportFinalizedWebhook", "requestBody": { "description": "A contribution report has been finalized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContributionReportFinalizedWebhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "ContributionReportFinalizedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "contribution_report.finalized", "operationId": "ContributionReportFinalizedV2Webhook", "requestBody": { "description": "A contribution report has been finalized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContributionReportFinalizedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupCreatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.created", "operationId": "GroupCreatedV2Webhook", "requestBody": { "description": "A group was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupReadyV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.ready", "operationId": "GroupReadyV2Webhook", "requestBody": { "description": "A group is ready", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupReadyV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupArchivedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.archived", "operationId": "GroupArchivedV2Webhook", "requestBody": { "description": "A group is archived", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupArchivedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupUpdatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.updated", "operationId": "GroupUpdatedV2Webhook", "requestBody": { "description": "A group was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupUpdatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupEmployeeAddedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.employee.added", "operationId": "GroupEmployeeAddedV2Webhook", "requestBody": { "description": "An employee was successfully added to the group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupEmployeeAddedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupEmployeeRemovedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.employee.removed", "operationId": "GroupEmployeeRemovedV2Webhook", "requestBody": { "description": "An employee was removed from the group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupEmployeeRemovedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupEmployeeEligibleV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.employee.eligible", "operationId": "GroupEmployeeEligibleV2Webhook", "requestBody": { "description": "An employee in the group that was previously `Ineligible` is now `Eligible`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupEmployeeEligibleV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupEmployeeMovedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.employee.moved", "operationId": "GroupEmployeeMovedV2Webhook", "requestBody": { "description": "An employee was moved from one group to another", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupEmployeeMovedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupEmployeeMoveScheduledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group.employee.move.scheduled", "operationId": "GroupEmployeeMoveScheduledV2Webhook", "requestBody": { "description": "An employee has been scheduled to move to a different group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupEmployeeMoveScheduledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyScheduledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.scheduled", "operationId": "PolicyScheduledV2Webhook", "requestBody": { "description": "A policy has been scheduled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyScheduledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyActiveV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.active", "operationId": "PolicyActiveV2Webhook", "requestBody": { "description": "A policy has been activated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyActiveV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyImportedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.imported", "operationId": "PolicyImportedV2Webhook", "requestBody": { "description": "A policy has been imported from an external system", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyImportedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyExpiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.expired", "operationId": "PolicyExpiredV2Webhook", "requestBody": { "description": "A policy has expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyExpiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyCancelledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.cancelled", "operationId": "PolicyCancelledV2Webhook", "requestBody": { "description": "A policy has been cancelled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyCancelledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyUpdatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.updated", "operationId": "PolicyUpdatedV2Webhook", "requestBody": { "description": "A policy has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyUpdatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyRenewalOpenedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.renewal.opened", "operationId": "PolicyRenewalOpenedV2Webhook", "requestBody": { "description": "A policy renewal has been opened", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRenewalOpenedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyRenewalRenewedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.renewal.renewed", "operationId": "PolicyRenewalRenewedV2Webhook", "requestBody": { "description": "A policy has been renewed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRenewalRenewedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyRenewalCanceledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy.renewal.canceled", "operationId": "PolicyRenewalCanceledV2Webhook", "requestBody": { "description": "A policy renewal has been canceled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyRenewalCanceledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyScheduledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy.scheduled", "operationId": "GroupPolicyScheduledV2Webhook", "requestBody": { "description": "A group policy has been scheduled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyScheduledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyActiveV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy.active", "operationId": "GroupPolicyActiveV2Webhook", "requestBody": { "description": "A group policy has been activated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyActiveV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyExpiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy.expired", "operationId": "GroupPolicyExpiredV2Webhook", "requestBody": { "description": "A group policy has expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyExpiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyCancelledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy.cancelled", "operationId": "GroupPolicyCancelledV2Webhook", "requestBody": { "description": "A group policy has been cancelled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyCancelledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyUpdatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy.updated", "operationId": "GroupPolicyUpdatedV2Webhook", "requestBody": { "description": "A group policy has been updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyUpdatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyRenewalOpenedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy.renewal.opened", "operationId": "GroupPolicyRenewalOpenedV2Webhook", "requestBody": { "description": "A group policy renewal has been opened", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyRenewalOpenedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyRenewalRenewedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy.renewal.renewed", "operationId": "GroupPolicyRenewalRenewedV2Webhook", "requestBody": { "description": "A group policy has been renewed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyRenewalRenewedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyRenewalCanceledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy.renewal.canceled", "operationId": "GroupPolicyRenewalCanceledV2Webhook", "requestBody": { "description": "A group policy renewal has been canceled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyRenewalCanceledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentProcessingV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.processing", "operationId": "EnrolmentIntentProcessingV2Webhook", "requestBody": { "description": "An enrolment intent is being processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentProcessingV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentScheduledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.scheduled", "operationId": "EnrolmentIntentScheduledV2Webhook", "requestBody": { "description": "An enrolment intent has been scheduled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentScheduledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentActionRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.action_required", "operationId": "EnrolmentIntentActionRequiredV2Webhook", "requestBody": { "description": "An enrolment intent requires action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentActionRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentEnrollingV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.enrolling", "operationId": "EnrolmentIntentEnrollingV2Webhook", "requestBody": { "description": "An enrolment intent is currently enrolling an employee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentEnrollingV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentEnrolledV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.enrolled", "operationId": "EnrolmentIntentEnrolledV2Webhook", "requestBody": { "description": "An enrolment intent has successfully enrolled an employee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentEnrolledV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentNotUndertakenV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.not_undertaken", "operationId": "EnrolmentIntentNotUndertakenV2Webhook", "requestBody": { "description": "An enrolment intent was not undertaken", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentNotUndertakenV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentIneligibleV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.ineligible", "operationId": "EnrolmentIntentIneligibleV2Webhook", "requestBody": { "description": "An enrolment intent can't progress because the employee is not eligible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentIneligibleV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentPendingConfirmationV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.pending_confirmation", "operationId": "EnrolmentIntentPendingConfirmationV2Webhook", "requestBody": { "description": "An enrolment intent requires a confirmation from employee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentPendingConfirmationV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EnrolmentIntentCoverageOptionsRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "enrolment_intent.coverage_options_required", "operationId": "EnrolmentIntentCoverageOptionsRequiredV2Webhook", "requestBody": { "description": "An enrolment intent requires coverage option selections", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrolmentIntentCoverageOptionsRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyAmendmentIntentActionRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_amendment_intent.action_required", "operationId": "PolicyAmendmentIntentActionRequiredV2Webhook", "requestBody": { "description": "A policy amendment intent requires action from the platform", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentActionRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyAmendmentIntentAwaitingQuoteV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_amendment_intent.awaiting_quote", "operationId": "PolicyAmendmentIntentAwaitingQuoteV2Webhook", "requestBody": { "description": "A policy amendment intent is waiting for a quote from the provider", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentAwaitingQuoteV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyAmendmentIntentPendingConfirmationV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_amendment_intent.pending_confirmation", "operationId": "PolicyAmendmentIntentPendingConfirmationV2Webhook", "requestBody": { "description": "A policy amendment intent is awaiting employee confirmation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentPendingConfirmationV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyAmendmentIntentProcessingV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_amendment_intent.processing", "operationId": "PolicyAmendmentIntentProcessingV2Webhook", "requestBody": { "description": "A policy amendment intent is being processed by the provider", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentProcessingV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyAmendmentIntentAmendedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_amendment_intent.amended", "operationId": "PolicyAmendmentIntentAmendedV2Webhook", "requestBody": { "description": "A policy amendment intent has been successfully completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentAmendedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyAmendmentIntentProcessingErrorV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_amendment_intent.processing_error", "operationId": "PolicyAmendmentIntentProcessingErrorV2Webhook", "requestBody": { "description": "A policy amendment intent encountered a processing error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentProcessingErrorV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyAmendmentIntentNotUndertakenV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_amendment_intent.not_undertaken", "operationId": "PolicyAmendmentIntentNotUndertakenV2Webhook", "requestBody": { "description": "A policy amendment intent was not undertaken", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyAmendmentIntentNotUndertakenV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "DependentsManagementIntentActionRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "dependents_management_intent.action_required", "operationId": "DependentsManagementIntentActionRequiredV2Webhook", "requestBody": { "description": "A dependents management intent requires action from the platform", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsManagementIntentActionRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "DependentsManagementIntentCompletedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "dependents_management_intent.completed", "operationId": "DependentsManagementIntentCompletedV2Webhook", "requestBody": { "description": "A dependents management intent has been successfully completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsManagementIntentCompletedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "DependentsManagementIntentNotUndertakenV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "dependents_management_intent.not_undertaken", "operationId": "DependentsManagementIntentNotUndertakenV2Webhook", "requestBody": { "description": "A dependents management intent was not undertaken", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsManagementIntentNotUndertakenV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyImportIntentProcessingV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_import_intent.processing", "operationId": "PolicyImportIntentProcessingV2Webhook", "requestBody": { "description": "A policy import intent is being processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyImportIntentProcessingV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyImportIntentSuccessV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_import_intent.success", "operationId": "PolicyImportIntentSuccessV2Webhook", "requestBody": { "description": "A policy import intent has been successfully completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyImportIntentSuccessV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "PolicyImportIntentFailedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "policy_import_intent.failed", "operationId": "PolicyImportIntentFailedV2Webhook", "requestBody": { "description": "A policy import intent has failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PolicyImportIntentFailedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupQuoteIntentProcessingV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_quote_intent.processing", "operationId": "GroupQuoteIntentProcessingV2Webhook", "requestBody": { "description": "A group quote intent is being processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentProcessingV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupQuoteIntentActionRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_quote_intent.action_required", "operationId": "GroupQuoteIntentActionRequiredV2Webhook", "requestBody": { "description": "A group quote intent requires action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentActionRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupQuoteIntentAwaitingQuoteV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_quote_intent.awaiting_quote", "operationId": "GroupQuoteIntentAwaitingQuoteV2Webhook", "requestBody": { "description": "A group quote intent is awaiting quote from insurer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentAwaitingQuoteV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupQuoteIntentQuoteAvailableV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_quote_intent.quote_available", "operationId": "GroupQuoteIntentQuoteAvailableV2Webhook", "requestBody": { "description": "A group quote intent has a quote available", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentQuoteAvailableV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupQuoteIntentRejectedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_quote_intent.rejected", "operationId": "GroupQuoteIntentRejectedV2Webhook", "requestBody": { "description": "A group quote intent was rejected by employer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentRejectedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupQuoteIntentRejectedByInsurerV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_quote_intent.rejected_by_insurer", "operationId": "GroupQuoteIntentRejectedByInsurerV2Webhook", "requestBody": { "description": "A group quote intent was rejected by the insurer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentRejectedByInsurerV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupQuoteIntentQuoteExpiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_quote_intent.quote_expired", "operationId": "GroupQuoteIntentQuoteExpiredV2Webhook", "requestBody": { "description": "A group quote intent quote has expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQuoteIntentQuoteExpiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyIntentProcessingV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy_intent.processing", "operationId": "GroupPolicyIntentProcessingV2Webhook", "requestBody": { "description": "A group policy intent is being processed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentProcessingV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyIntentActionRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy_intent.action_required", "operationId": "GroupPolicyIntentActionRequiredV2Webhook", "requestBody": { "description": "A group policy intent requires action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentActionRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyIntentPendingProviderApprovalV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy_intent.pending_provider_approval", "operationId": "GroupPolicyIntentPendingProviderApprovalV2Webhook", "requestBody": { "description": "A group policy intent is pending provider approval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentPendingProviderApprovalV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyIntentPolicyCreatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy_intent.policy_created", "operationId": "GroupPolicyIntentPolicyCreatedV2Webhook", "requestBody": { "description": "A group policy intent has completed setup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentPolicyCreatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyIntentExpiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy_intent.expired", "operationId": "GroupPolicyIntentExpiredV2Webhook", "requestBody": { "description": "A group policy intent has expired", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentExpiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyIntentProviderRejectedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy_intent.provider_rejected", "operationId": "GroupPolicyIntentProviderRejectedV2Webhook", "requestBody": { "description": "A group policy intent was rejected by the provider", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentProviderRejectedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "GroupPolicyIntentManualRenewalGatheringRequiredV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "group_policy_intent.manual_renewal_gathering_required", "operationId": "GroupPolicyIntentManualRenewalGatheringRequiredV2Webhook", "requestBody": { "description": "A group policy intent requires manual renewal gathering", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPolicyIntentManualRenewalGatheringRequiredV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "AssociatedPersonUpdatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "associated_person.updated", "operationId": "AssociatedPersonUpdatedV2Webhook", "requestBody": { "description": "An associated person was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssociatedPersonUpdatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "InvoiceCreatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "invoice.created", "operationId": "InvoiceCreatedV2Webhook", "requestBody": { "description": "An invoice was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceCreatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "InvoiceUpdatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "invoice.updated", "operationId": "InvoiceUpdatedV2Webhook", "requestBody": { "description": "An invoice was updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceUpdatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeSalaryCreatedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.salary_created", "operationId": "EmployeeSalaryCreatedV2Webhook", "requestBody": { "description": "A salary record was created for an employee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeSalaryCreatedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } }, "EmployeeSalaryDeletedV2Webhook": { "post": { "tags": [ "Types of events V2" ], "summary": "employee.salary_deleted", "operationId": "EmployeeSalaryDeletedV2Webhook", "requestBody": { "description": "A salary record was deleted for an employee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeSalaryDeletedV2Webhook" } } } }, "responses": { "2xx": { "description": "Your server implementation should return this HTTP status code if the data was received successfully" }, "4xx": { "description": "If your server returns an HTTP status code indicating it does not understand the format of the payload the delivery will be treated as a failure. Multiple retries will be attempted!" }, "5xx": { "description": "If your server returns an HTTP status code indicating a server-side error the delivery will be treated as a failure. Multiple retries will be attempted!" } }, "x-fern-webhook": true } } } }