### GET /users Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Retrieves a list of system users. ```APIDOC ## GET /users ### Description Get system users. ### Method GET ### Endpoint /users ``` -------------------------------- ### Complete Coverage Period Setup Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Indicate that data loading for a coverage period is complete. ```APIDOC ## POST /coverage_periods/{id}/complete_setup ### Description Tell Ideon that the data has been fully loaded for a Coverage Period. ### Method POST ### Endpoint /coverage_periods/{id}/complete_setup ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the coverage period. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation that setup is complete. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Complete Coverage Period Setup Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Signal that data loading for a coverage period is complete using this POST request. ```http POST /coverage_periods/{id}/complete_setup ``` -------------------------------- ### Get Listing of Groups Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Retrieve a list of groups associated with your account using this GET request. ```http GET /groups ``` -------------------------------- ### Paginated Group Request Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints supporting pagination can be controlled using 'page' and 'per_page' query parameters. This example shows fetching the second page with 5 results per page. ```http GET /groups?....page=2&per_page=5 ``` -------------------------------- ### Show Coverage Period Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Retrieve details of a specific enrollment coverage period by its ID using this GET request. ```http GET /coverage_periods/{id} ``` -------------------------------- ### Get Coverage Period Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Retrieve details of a specific enrollment coverage period. ```APIDOC ## GET /coverage_periods/{id} ### Description Show an enrollment coverage period. ### Method GET ### Endpoint /coverage_periods/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the coverage period. ### Response #### Success Response (200) - **coverage_details** (object) - Details of the coverage period. ### Request Example ```json { "example": "request body" } ``` ### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Authenticate and Get Token Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments This endpoint is used to obtain a short-lived authentication token. Use this token for subsequent API requests. ```http POST /auth/token ``` -------------------------------- ### Get Group Status Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Check the current status of a specific group by its ID using this GET request. ```http GET /groups/{id} ``` -------------------------------- ### Authenticate with API Key Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments To authenticate API calls, include your API Key in the 'Vericred-Api-Key' header. This is a common method for initial access. ```bash curl -H 'Vericred-Api-Key: YOUR_KEY' "https://enrollments.vericred.com/groups" ``` -------------------------------- ### Get Group Status Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Retrieve the current status of a specific group. ```APIDOC ## GET /groups/{id} ### Description Get the status of a group. ### Method GET ### Endpoint /groups/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the group. ### Response #### Success Response (200) - **status** (string) - The current status of the group. ### Request Example ```json { "example": "request body" } ``` ### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Create Coverage Period Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Initiate a new enrollment coverage period for a carrier group using this POST request. ```http POST /groups/{id}/coverage_periods ``` -------------------------------- ### Hooks Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoint for creating webhooks for groups. ```APIDOC ## POST /groups/{id}/hooks ### Description Creates a webhook for a group. ### Method POST ### Endpoint /groups/{id}/hooks ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the group to create the webhook for. ### Request Body - **url** (string) - Required - The URL to send webhook notifications to. - **event_type** (string) - Required - The type of event that triggers the webhook (e.g., 'coverage_period.created'). ### Request Example ```json { "url": "https://example.com/webhook", "event_type": "coverage_period.created" } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the newly created webhook. - **group_id** (string) - The ID of the group. - **url** (string) - The URL of the webhook. - **event_type** (string) - The event type that triggers the webhook. #### Response Example ```json { "id": "hook_id_1", "group_id": "group_id_1", "url": "https://example.com/webhook", "event_type": "coverage_period.created" } ``` ``` -------------------------------- ### Provide Plan for Coverage Period Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Submit plan details for a carrier group coverage period using this POST request. ```http POST /coverage_periods/{id}/plans ``` -------------------------------- ### Plans Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for updating plan details. ```APIDOC ## PUT /plans/{id} ### Description Updates an existing plan by its ID. ### Method PUT ### Endpoint /plans/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the plan to update. ### Request Body - **name** (string) - Optional - The new name of the plan. - **description** (string) - Optional - The new description of the plan. ### Request Example ```json { "name": "Updated Plan Name" } ``` ### Response #### Success Response (200) - **id** (string) - The ID of the updated plan. - **name** (string) - The updated name of the plan. - **description** (string) - The updated description of the plan. #### Response Example ```json { "id": "plan_id_123", "name": "Updated Plan Name", "description": "Updated plan description." } ``` ``` -------------------------------- ### Enrollment Problems Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for retrieving enrollment problems and managing their comments and resolutions. ```APIDOC ## GET /coverage_periods/{id}/errors ### Description Retrieves a list of enrollment problems associated with a specific coverage period. ### Method GET ### Endpoint /coverage_periods/{id}/errors ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period. ### Response #### Success Response (200) - **errors** (array) - A list of enrollment problem objects. #### Response Example ```json { "errors": [ { "id": "error_id_1", "message": "Missing subscriber information." } ] } ``` ``` ```APIDOC ## GET /errors/{id} ### Description Retrieves details for a specific enrollment problem by its ID. ### Method GET ### Endpoint /errors/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the enrollment problem to retrieve. ### Response #### Success Response (200) - **id** (string) - The ID of the enrollment problem. - **message** (string) - The description of the enrollment problem. #### Response Example ```json { "id": "error_id_1", "message": "Missing subscriber information." } ``` ``` ```APIDOC ## POST /errors/{id}/comments ### Description Adds a comment to an enrollment problem. ### Method POST ### Endpoint /errors/{id}/comments ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the enrollment problem to add a comment to. ### Request Body - **comment** (string) - Required - The content of the comment. ### Request Example ```json { "comment": "Investigating the issue." } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the enrollment problem. - **comment_id** (string) - The ID of the added comment. - **comment** (string) - The content of the comment. #### Response Example ```json { "id": "error_id_1", "comment_id": "comment_id_abc", "comment": "Investigating the issue." } ``` ``` ```APIDOC ## POST /errors/{id}/resolution ### Description Marks an enrollment problem as resolved. ### Method POST ### Endpoint /errors/{id}/resolution ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the enrollment problem to resolve. ### Request Body - **resolution_notes** (string) - Optional - Notes regarding the resolution. ### Request Example ```json { "resolution_notes": "Information provided by the user." } ``` ### Response #### Success Response (200) - **id** (string) - The ID of the enrollment problem. - **status** (string) - The updated status of the enrollment problem (e.g., 'resolved'). #### Response Example ```json { "id": "error_id_1", "status": "resolved" } ``` ``` -------------------------------- ### Tasks Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for managing tasks, including retrieval, creation, and status updates. ```APIDOC ## GET /coverage_periods/{id}/tasks ### Description Retrieves a list of tasks associated with a specific coverage period. ### Method GET ### Endpoint /coverage_periods/{id}/tasks ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period. ### Response #### Success Response (200) - **tasks** (array) - A list of task objects. #### Response Example ```json { "tasks": [ { "id": "task_id_1", "title": "Review enrollment data", "status": "open" } ] } ``` ``` ```APIDOC ## POST /coverage_periods/{id}/tasks ### Description Creates a new task for a specific coverage period. ### Method POST ### Endpoint /coverage_periods/{id}/tasks ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period to create the task for. ### Request Body - **title** (string) - Required - The title of the task. - **description** (string) - Optional - A detailed description of the task. ### Request Example ```json { "title": "Verify subscriber details", "description": "Check all subscriber information for accuracy." } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the newly created task. - **coverage_period_id** (string) - The ID of the coverage period. - **title** (string) - The title of the task. #### Response Example ```json { "id": "task_id_2", "coverage_period_id": "coverage_period_id", "title": "Verify subscriber details" } ``` ``` ```APIDOC ## GET /tasks ### Description Retrieves a list of all tasks. ### Method GET ### Endpoint /tasks ### Response #### Success Response (200) - **tasks** (array) - A list of task objects. #### Response Example ```json { "tasks": [ { "id": "task_id_1", "title": "Review enrollment data", "status": "open" }, { "id": "task_id_2", "title": "Verify subscriber details", "status": "in_progress" } ] } ``` ``` ```APIDOC ## GET /tasks/{id} ### Description Retrieves details for a specific task by its ID. ### Method GET ### Endpoint /tasks/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the task to retrieve. ### Response #### Success Response (200) - **id** (string) - The ID of the task. - **title** (string) - The title of the task. - **description** (string) - The description of the task. - **status** (string) - The current status of the task. #### Response Example ```json { "id": "task_id_1", "title": "Review enrollment data", "description": "Review all submitted enrollment forms.", "status": "open" } ``` ``` ```APIDOC ## PUT /tasks/{id}/complete ### Description Marks a task as complete. ### Method PUT ### Endpoint /tasks/{id}/complete ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the task to mark as complete. ### Response #### Success Response (200) - **id** (string) - The ID of the task. - **status** (string) - The updated status of the task (e.g., 'completed'). #### Response Example ```json { "id": "task_id_1", "status": "completed" } ``` ``` ```APIDOC ## PUT /tasks/{id}/reopen ### Description Reopens a completed task. ### Method PUT ### Endpoint /tasks/{id}/reopen ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the task to reopen. ### Response #### Success Response (200) - **id** (string) - The ID of the task. - **status** (string) - The updated status of the task (e.g., 'reopened'). #### Response Example ```json { "id": "task_id_1", "status": "reopened" } ``` ``` -------------------------------- ### Enrollment Problems Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for retrieving and managing enrollment problems and their associated comments and resolutions. ```APIDOC ## GET /coverage_periods/{id}/errors ### Description Get a coverage period's errors. ### Method GET ### Endpoint /coverage_periods/{id}/errors ``` ```APIDOC ## GET /errors/{id} ### Description Get an error. ### Method GET ### Endpoint /errors/{id} ``` ```APIDOC ## POST /errors/{id}/comments ### Description Add a new comment to an Enrollment Problem. ### Method POST ### Endpoint /errors/{id}/comments ``` ```APIDOC ## POST /errors/{id}/resolution ### Description Resolve an error. ### Method POST ### Endpoint /errors/{id}/resolution ``` -------------------------------- ### Create Plan for Coverage Period Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Add a plan for a carrier group's coverage period. ```APIDOC ## POST /coverage_periods/{id}/plans ### Description Provide a plan for a carrier group coverage period. ### Method POST ### Endpoint /coverage_periods/{id}/plans ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the coverage period. ### Request Body - **plan_details** (object) - Required - Details of the plan to be added. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (201) - **message** (string) - Confirmation of successful plan creation. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Supporting Documents Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for managing supporting documents for coverage periods and qualifying life events. ```APIDOC ## GET /coverage_periods/{id}/supporting_documents ### Description Retrieves a list of supporting documents for a specific coverage period. ### Method GET ### Endpoint /coverage_periods/{id}/supporting_documents ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period. ### Response #### Success Response (200) - **supporting_documents** (array) - A list of supporting document objects. #### Response Example ```json { "supporting_documents": [ { "id": "doc_id_1", "file_name": "document.pdf", "uploaded_at": "2023-10-26T10:00:00Z" } ] } ``` ``` ```APIDOC ## GET /supporting_documents/{id} ### Description Retrieves details for a specific supporting document by its ID. ### Method GET ### Endpoint /supporting_documents/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the supporting document to retrieve. ### Response #### Success Response (200) - **id** (string) - The ID of the supporting document. - **file_name** (string) - The name of the file. - **uploaded_at** (string) - The timestamp when the document was uploaded. #### Response Example ```json { "id": "doc_id_1", "file_name": "document.pdf", "uploaded_at": "2023-10-26T10:00:00Z" } ``` ``` ```APIDOC ## PUT /supporting_documents/{id}/current ### Description Marks a supporting document as the current version. ### Method PUT ### Endpoint /supporting_documents/{id}/current ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the supporting document to mark as current. ### Response #### Success Response (200) - **id** (string) - The ID of the supporting document. - **is_current** (boolean) - Indicates if this is the current version. #### Response Example ```json { "id": "doc_id_1", "is_current": true } ``` ``` ```APIDOC ## GET /qualifying_life_events/{id}/supporting_documents ### Description Retrieves a list of supporting documents for a specific qualifying life event. ### Method GET ### Endpoint /qualifying_life_events/{id}/supporting_documents ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the qualifying life event. ### Response #### Success Response (200) - **supporting_documents** (array) - A list of supporting document objects. #### Response Example ```json { "supporting_documents": [ { "id": "doc_id_2", "file_name": "proof_of_birth.pdf", "uploaded_at": "2023-10-26T11:00:00Z" } ] } ``` ``` ```APIDOC ## POST /qualifying_life_events/{id}/supporting_documents ### Description Uploads a supporting document for a qualifying life event. ### Method POST ### Endpoint /qualifying_life_events/{id}/supporting_documents ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the qualifying life event to associate the document with. ### Request Body - **file** (file) - Required - The supporting document file. - **description** (string) - Optional - A description of the document. ### Request Example ```json { "file": "", "description": "Birth certificate" } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the uploaded supporting document. - **qualifying_life_event_id** (string) - The ID of the qualifying life event. - **file_name** (string) - The name of the uploaded file. #### Response Example ```json { "id": "doc_id_2", "qualifying_life_event_id": "qle_id_1", "file_name": "proof_of_birth.pdf" } ``` ``` -------------------------------- ### Tasks Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for managing tasks associated with coverage periods and general task operations. ```APIDOC ## GET /coverage_periods/{id}/tasks ### Description Get workflow or customer tasks for a Coverage Period. ### Method GET ### Endpoint /coverage_periods/{id}/tasks ``` ```APIDOC ## POST /coverage_periods/{id}/tasks ### Description Create a task for a coverage period. ### Method POST ### Endpoint /coverage_periods/{id}/tasks ``` ```APIDOC ## GET /tasks ### Description Get workflow or customer tasks. ### Method GET ### Endpoint /tasks ``` ```APIDOC ## GET /tasks/{id} ### Description Get the details of a task. ### Method GET ### Endpoint /tasks/{id} ``` ```APIDOC ## PUT /tasks/{id}/complete ### Description Mark a task as complete. ### Method PUT ### Endpoint /tasks/{id}/complete ``` ```APIDOC ## PUT /tasks/{id}/reopen ### Description Reopen a task. ### Method PUT ### Endpoint /tasks/{id}/reopen ``` -------------------------------- ### Authentication Token Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Obtain a short-lived authentication token by passing the API Key in the headers. ```APIDOC ## POST /auth/token ### Description Authenticate and receive a short-lived token. ### Method POST ### Endpoint /auth/token ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **token** (string) - The authentication token. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Supporting Documents Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for managing supporting documents related to coverage periods, qualifying life events, and specific documents. ```APIDOC ## GET /coverage_periods/{id}/supporting_documents ### Description Show supporting documents for an enrollment coverage period. ### Method GET ### Endpoint /coverage_periods/{id}/supporting_documents ``` ```APIDOC ## GET /supporting_documents/{id} ### Description Get a supporting document. ### Method GET ### Endpoint /supporting_documents/{id} ``` ```APIDOC ## PUT /supporting_documents/{id}/current ### Description Put a new version of a supporting document. ### Method PUT ### Endpoint /supporting_documents/{id}/current ``` ```APIDOC ## GET /qualifying_life_events/{id}/supporting_documents ### Description List supporting documents for a qualifying life event. ### Method GET ### Endpoint /qualifying_life_events/{id}/supporting_documents ``` ```APIDOC ## POST /qualifying_life_events/{id}/supporting_documents ### Description Add a new supporting document for the given qualifying life event. ### Method POST ### Endpoint /qualifying_life_events/{id}/supporting_documents ``` -------------------------------- ### ICHRA Applications Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for retrieving ICHRA applications. ```APIDOC ## GET /ichra/applications ### Description Retrieves a list of all ICHRA applications. ### Method GET ### Endpoint /ichra/applications ### Response #### Success Response (200) - **applications** (array) - A list of ICHRA application objects. #### Response Example ```json { "applications": [ { "id": "ichra_app_id_1", "status": "submitted" } ] } ``` ``` ```APIDOC ## GET /ichra/applications/{id} ### Description Retrieves details for a specific ICHRA application by its ID. ### Method GET ### Endpoint /ichra/applications/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the ICHRA application to retrieve. ### Response #### Success Response (200) - **id** (string) - The ID of the ICHRA application. - **status** (string) - The status of the application. #### Response Example ```json { "id": "ichra_app_id_1", "status": "submitted" } ``` ``` -------------------------------- ### ICHRA Applications Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for retrieving ICHRA applications. ```APIDOC ## GET /ichra/applications ### Description Get a listing of ICHRA applications. ### Method GET ### Endpoint /ichra/applications ``` ```APIDOC ## GET /ichra/applications/{id} ### Description Get details of a single ICHRA application. ### Method GET ### Endpoint /ichra/applications/{id} ``` -------------------------------- ### Create Group Enrollment Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Submit group and member information for insurance enrollment. ```APIDOC ## POST /groups ### Description Provide a group and members for enrollment in insurance coverage. ### Method POST ### Endpoint /groups ### Request Body - **group** (object) - Required - Information about the group. - **members** (array) - Required - A list of members to enroll. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (201) - **message** (string) - Confirmation of successful enrollment. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Create Coverage Period Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Establish a new enrollment coverage period for a carrier group. ```APIDOC ## POST /groups/{id}/coverage_periods ### Description Create an enrollment coverage period for a carrier group. ### Method POST ### Endpoint /groups/{id}/coverage_periods ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the group. ### Request Body - **coverage_details** (object) - Required - Details of the coverage period. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (201) - **message** (string) - Confirmation of successful creation. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Coverage Periods Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for managing coverage periods, including creation, retrieval, updates, and associated plans. ```APIDOC ## POST /groups/{id}/coverage_periods ### Description Creates a new coverage period for a specific group. ### Method POST ### Endpoint /groups/{id}/coverage_periods ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the group to associate the coverage period with. ### Request Body - **start_date** (string) - Required - The start date of the coverage period (YYYY-MM-DD). - **end_date** (string) - Required - The end date of the coverage period (YYYY-MM-DD). ### Request Example ```json { "start_date": "2023-01-01", "end_date": "2023-12-31" } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the newly created coverage period. - **group_id** (string) - The ID of the group. - **start_date** (string) - The start date of the coverage period. - **end_date** (string) - The end date of the coverage period. #### Response Example ```json { "id": "coverage_period_id", "group_id": "group_id_1", "start_date": "2023-01-01", "end_date": "2023-12-31" } ``` ``` ```APIDOC ## GET /coverage_periods/{id} ### Description Retrieves details for a specific coverage period by its ID. ### Method GET ### Endpoint /coverage_periods/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period to retrieve. ### Response #### Success Response (200) - **id** (string) - The ID of the coverage period. - **group_id** (string) - The ID of the group. - **start_date** (string) - The start date of the coverage period. - **end_date** (string) - The end date of the coverage period. #### Response Example ```json { "id": "coverage_period_id", "group_id": "group_id_1", "start_date": "2023-01-01", "end_date": "2023-12-31" } ``` ``` ```APIDOC ## PUT /coverage_periods/{id} ### Description Updates an existing coverage period by its ID. ### Method PUT ### Endpoint /coverage_periods/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period to update. ### Request Body - **start_date** (string) - Optional - The new start date of the coverage period (YYYY-MM-DD). - **end_date** (string) - Optional - The new end date of the coverage period (YYYY-MM-DD). ### Request Example ```json { "end_date": "2023-12-31" } ``` ### Response #### Success Response (200) - **id** (string) - The ID of the updated coverage period. - **group_id** (string) - The ID of the group. - **start_date** (string) - The updated start date of the coverage period. - **end_date** (string) - The updated end date of the coverage period. #### Response Example ```json { "id": "coverage_period_id", "group_id": "group_id_1", "start_date": "2023-01-01", "end_date": "2023-12-31" } ``` ``` ```APIDOC ## POST /coverage_periods/{id}/plans ### Description Adds a plan to a coverage period. ### Method POST ### Endpoint /coverage_periods/{id}/plans ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period to add the plan to. ### Request Body - **plan_id** (string) - Required - The ID of the plan to add. ### Request Example ```json { "plan_id": "plan_id_123" } ``` ### Response #### Success Response (201) - **coverage_period_id** (string) - The ID of the coverage period. - **plan_id** (string) - The ID of the added plan. #### Response Example ```json { "coverage_period_id": "coverage_period_id", "plan_id": "plan_id_123" } ``` ``` -------------------------------- ### Authentication Token Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Obtain an authentication token for accessing protected API resources. ```APIDOC ## POST /auth/token ### Description Obtains an authentication token required for subsequent API requests. ### Method POST ### Endpoint /auth/token ### Request Example ```json { "username": "your_username", "password": "your_password" } ``` ### Response #### Success Response (200) - **token** (string) - The authentication token. #### Response Example ```json { "token": "your_auth_token" } ``` ``` -------------------------------- ### Policy Inquiries Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoint for submitting policy inquiries. ```APIDOC ## POST /policy_inquiries ### Description Submits a new policy inquiry. ### Method POST ### Endpoint /policy_inquiries ### Request Body - **inquiry_details** (string) - Required - The details of the policy inquiry. ### Request Example ```json { "inquiry_details": "Inquiry about coverage for policy XYZ." } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the submitted policy inquiry. - **status** (string) - The status of the inquiry (e.g., 'received'). #### Response Example ```json { "id": "policy_inquiry_id_1", "status": "received" } ``` ``` -------------------------------- ### Users Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoint for retrieving a list of users. ```APIDOC ## GET /users ### Description Retrieves a list of all users. ### Method GET ### Endpoint /users ### Response #### Success Response (200) - **users** (array) - A list of user objects. #### Response Example ```json { "users": [ { "id": "user_id_abc", "username": "johndoe" } ] } ``` ``` -------------------------------- ### Reporting Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for retrieving reporting data related to coverage transmissions and file deliveries. ```APIDOC ## GET /coverage_periods/{id}/coverage_transmissions ### Description Show the latest coverage transmissions for the selected coverage period. ### Method GET ### Endpoint /coverage_periods/{id}/coverage_transmissions ``` ```APIDOC ## GET /members/{id}/coverage_transmissions ### Description Show the latest coverage transmissions for the selected member. ### Method GET ### Endpoint /members/{id}/coverage_transmissions ``` ```APIDOC ## GET /coverage_periods/{id}/file_deliveries ### Description Gets coverage period's file deliveries. ### Method GET ### Endpoint /coverage_periods/{id}/file_deliveries ``` ```APIDOC ## GET /file_deliveries/{id}/coverage_transmissions ### Description Show the latest coverage transmissions for the selected file delivery. ### Method GET ### Endpoint /file_deliveries/{id}/coverage_transmissions ``` -------------------------------- ### List Groups Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Retrieve a list of groups associated with the account. ```APIDOC ## GET /groups ### Description Get a listing of the groups for this account. ### Method GET ### Endpoint /groups ### Parameters #### Query Parameters - **page** (integer) - Optional - The page number for pagination. - **per_page** (integer) - Optional - The number of results per page. ### Response #### Success Response (200) - **Total** (integer) - The total number of groups available. - **Per-Page** (integer) - The number of groups returned per page. - **Link** (string) - A link to the next page of results. - **Page** (integer) - The current page number. ### Request Example ```json { "example": "request body" } ``` ### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Groups Management Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for managing groups, including retrieval, creation, and updates. ```APIDOC ## GET /groups ### Description Retrieves a list of all groups. ### Method GET ### Endpoint /groups ### Response #### Success Response (200) - **groups** (array) - A list of group objects. #### Response Example ```json { "groups": [ { "id": "group_id_1", "name": "Example Group 1" }, { "id": "group_id_2", "name": "Example Group 2" } ] } ``` ``` ```APIDOC ## POST /groups ### Description Creates a new group. ### Method POST ### Endpoint /groups ### Request Body - **name** (string) - Required - The name of the group. ### Request Example ```json { "name": "New Group Name" } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the newly created group. - **name** (string) - The name of the newly created group. #### Response Example ```json { "id": "new_group_id", "name": "New Group Name" } ``` ``` ```APIDOC ## GET /groups/{id} ### Description Retrieves details for a specific group by its ID. ### Method GET ### Endpoint /groups/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the group to retrieve. ### Response #### Success Response (200) - **id** (string) - The ID of the group. - **name** (string) - The name of the group. #### Response Example ```json { "id": "group_id_1", "name": "Example Group 1" } ``` ``` ```APIDOC ## PUT /groups/{id} ### Description Updates an existing group by its ID. ### Method PUT ### Endpoint /groups/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the group to update. ### Request Body - **name** (string) - Optional - The new name for the group. ### Request Example ```json { "name": "Updated Group Name" } ``` ### Response #### Success Response (200) - **id** (string) - The ID of the updated group. - **name** (string) - The updated name of the group. #### Response Example ```json { "id": "group_id_1", "name": "Updated Group Name" } ``` ``` -------------------------------- ### Enroll Group and Members Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Submit group and member information for insurance enrollment using this POST request. ```http POST /groups ``` -------------------------------- ### Update Plan Information Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Modify the information for an existing plan using its ID with this PUT request. ```http PUT /plans/{id} ``` -------------------------------- ### Reporting Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for generating reports related to coverage periods and members. ```APIDOC ## GET /coverage_periods/{id}/coverage_transmissions ### Description Retrieves coverage transmissions for a specific coverage period. ### Method GET ### Endpoint /coverage_periods/{id}/coverage_transmissions ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period. ### Response #### Success Response (200) - **coverage_transmissions** (array) - A list of coverage transmission objects. #### Response Example ```json { "coverage_transmissions": [ { "id": "transmission_id_1", "transmission_date": "2023-10-26T12:00:00Z" } ] } ``` ``` ```APIDOC ## GET /members/{id}/coverage_transmissions ### Description Retrieves coverage transmissions for a specific member. ### Method GET ### Endpoint /members/{id}/coverage_transmissions ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the member. ### Response #### Success Response (200) - **coverage_transmissions** (array) - A list of coverage transmission objects. #### Response Example ```json { "coverage_transmissions": [ { "id": "transmission_id_2", "transmission_date": "2023-10-26T13:00:00Z" } ] } ``` ``` ```APIDOC ## GET /coverage_periods/{id}/file_deliveries ### Description Retrieves file deliveries for a specific coverage period. ### Method GET ### Endpoint /coverage_periods/{id}/file_deliveries ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the coverage period. ### Response #### Success Response (200) - **file_deliveries** (array) - A list of file delivery objects. #### Response Example ```json { "file_deliveries": [ { "id": "delivery_id_1", "file_name": "report.csv", "delivered_at": "2023-10-26T14:00:00Z" } ] } ``` ``` ```APIDOC ## GET /file_deliveries/{id}/coverage_transmissions ### Description Retrieves coverage transmissions associated with a specific file delivery. ### Method GET ### Endpoint /file_deliveries/{id}/coverage_transmissions ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the file delivery. ### Response #### Success Response (200) - **coverage_transmissions** (array) - A list of coverage transmission objects. #### Response Example ```json { "coverage_transmissions": [ { "id": "transmission_id_3", "transmission_date": "2023-10-26T15:00:00Z" } ] } ``` ``` -------------------------------- ### Subscribers Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for managing subscribers, including retrieval, creation, and updates. ```APIDOC ## GET /groups/{id}/subscribers ### Description Retrieves a list of subscribers for a specific group. ### Method GET ### Endpoint /groups/{id}/subscribers ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the group whose subscribers to retrieve. ### Response #### Success Response (200) - **subscribers** (array) - A list of subscriber objects. #### Response Example ```json { "subscribers": [ { "id": "subscriber_id_1", "first_name": "John", "last_name": "Doe" } ] } ``` ``` ```APIDOC ## POST /groups/{id}/subscribers ### Description Creates a new subscriber for a specific group. ### Method POST ### Endpoint /groups/{id}/subscribers ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the group to add the subscriber to. ### Request Body - **first_name** (string) - Required - The first name of the subscriber. - **last_name** (string) - Required - The last name of the subscriber. - **dob** (string) - Required - The date of birth of the subscriber (YYYY-MM-DD). ### Request Example ```json { "first_name": "Jane", "last_name": "Smith", "dob": "1990-05-15" } ``` ### Response #### Success Response (201) - **id** (string) - The ID of the newly created subscriber. - **first_name** (string) - The first name of the subscriber. - **last_name** (string) - The last name of the subscriber. - **dob** (string) - The date of birth of the subscriber. #### Response Example ```json { "id": "subscriber_id_2", "first_name": "Jane", "last_name": "Smith", "dob": "1990-05-15" } ``` ``` ```APIDOC ## GET /subscribers/{id} ### Description Retrieves details for a specific subscriber by their ID. ### Method GET ### Endpoint /subscribers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the subscriber to retrieve. ### Response #### Success Response (200) - **id** (string) - The ID of the subscriber. - **first_name** (string) - The first name of the subscriber. - **last_name** (string) - The last name of the subscriber. - **dob** (string) - The date of birth of the subscriber. #### Response Example ```json { "id": "subscriber_id_1", "first_name": "John", "last_name": "Doe", "dob": "1985-11-20" } ``` ``` ```APIDOC ## PUT /subscribers/{id} ### Description Updates an existing subscriber by their ID. ### Method PUT ### Endpoint /subscribers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the subscriber to update. ### Request Body - **first_name** (string) - Optional - The new first name of the subscriber. - **last_name** (string) - Optional - The new last name of the subscriber. - **dob** (string) - Optional - The new date of birth of the subscriber (YYYY-MM-DD). ### Request Example ```json { "last_name": "Smith" } ``` ### Response #### Success Response (200) - **id** (string) - The ID of the updated subscriber. - **first_name** (string) - The updated first name of the subscriber. - **last_name** (string) - The updated last name of the subscriber. - **dob** (string) - The updated date of birth of the subscriber. #### Response Example ```json { "id": "subscriber_id_1", "first_name": "John", "last_name": "Smith", "dob": "1985-11-20" } ``` ``` -------------------------------- ### Policy Inquiries Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoint for requesting eligibility information for a member. ```APIDOC ## POST /policy_inquiries ### Description Request eligibility information for a member. ### Method POST ### Endpoint /policy_inquiries ``` -------------------------------- ### LDEx Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoint for submitting data to LDEx. ```APIDOC ## POST /rsp ### Description Submits data to the LDEx system. ### Method POST ### Endpoint /rsp ### Request Body - **data** (object) - Required - The data payload to submit. ### Request Example ```json { "data": { "key": "value" } } ``` ### Response #### Success Response (200) - **message** (string) - A confirmation message. #### Response Example ```json { "message": "Data submitted successfully to LDEx." } ``` ``` -------------------------------- ### Subscribers Source: https://app.swaggerhub.com/apis/VericredEnrollments/Enrollments Endpoints for managing subscribers, including retrieval, creation, and status updates. ```APIDOC ## GET /groups/{id}/subscribers ### Description Get a group's subscribers. ### Method GET ### Endpoint /groups/{id}/subscribers ``` ```APIDOC ## POST /groups/{id}/subscribers ### Description Provide a new subscriber for enrollment in insurance coverage. ### Method POST ### Endpoint /groups/{id}/subscribers ``` ```APIDOC ## GET /subscribers/{id} ### Description Get the status of a subscriber. ### Method GET ### Endpoint /subscribers/{id} ``` ```APIDOC ## PUT /subscribers/{id} ### Description Update the demographic, employment, and contact details of the subscriber. ### Method PUT ### Endpoint /subscribers/{id} ```