# Policy Status API **The Policy Status** sends notifications when a policy is effectuated, cancelled (i.e., never took effect) or terminated (i.e., ended after being in force), as well as when payment information us updated. On-exchange notifications provide less detail than off-exchange plans due to regulatory restrictions. Below are links to hop to documentation for On-Exchange and Off-Exchange plans: * [On-Exchange Plans](#on-exchange-plans) * [Off-Exchange Plans](#off-exchange-plans) ### On-Exchange Plans ## POST /your-endpoint-url > ```json {"openapi":"3.0.0","info":{"title":"Policy Status - On-Ex","version":"1.0.0"},"paths":{"/your-endpoint-url":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnExPolicyStatusPayload"}}}},"responses":{"200":{"description":"Successful response"}}}}},"components":{"schemas":{"OnExPolicyStatusPayload":{"type":"object","description":"Payload for On-Exchange Sync Events","required":["transaction_id","event_type","event_timestamp"],"properties":{"transaction_id":{"type":"integer","description":"Unique confirmation ID from the managed application"},"policy_status":{"type":"string","nullable":true,"description":"Status of the FFM policy","enum":["effectuated","cancelled","terminated"]},"event_type":{"type":"string","description":"Type of event being processed","enum":["sync"]},"event_timestamp":{"type":"string","format":"date-time","nullable":true,"description":"Timestamp of the last EDE synchronization"},"external_id":{"type":"string","nullable":true,"description":"External identifier for the enrollment lead"},"policy_aor_npn":{"type":"string","nullable":true,"description":"National Producer Number (NPN) on defined assistor for the policy"},"submitter_npn":{"type":"string","nullable":true,"description":"National Producer Number (NPN) of the agent"},"npn_used_at_submission":{"type":"string","nullable":true,"description":"National Producer Number (NPN) used during application submission"},"issuer_member_id":{"type":"string","nullable":true,"description":"Carrier-assigned member ID from the active health policy's external policy record. Null if the carrier has not yet assigned or shared a member ID."},"payment":{"$ref":"#/components/schemas/Payment"}}},"Payment":{"type":"object","nullable":true,"description":"Payment information for a policy. The payment key is always present (set to null if no payment data is available).\n","properties":{"payment_status":{"type":"string","enum":["unpaid_binder","paid_binder","paid","past_due"],"description":"Current payment status of the policy"},"payment_status_updated_date":{"type":"string","nullable":true,"description":"Date when payment status was last updated (MM/DD/YYYY format)"},"grace_period_start_date":{"type":"string","nullable":true,"description":"Start date of grace period, if applicable (MM/DD/YYYY format)"},"paid_through_date":{"type":"string","nullable":true,"description":"Date through which the policy is paid (MM/DD/YYYY format)"},"past_due_member_responsibility_balance_due":{"type":"string","description":"Past due balance amount (decimal string with 2 decimal places, e.g., \"150.00\")"},"current_member_responsibility_balance_due":{"type":"string","description":"Current balance amount (decimal string with 2 decimal places, e.g., \"50.50\")"},"autopay_indicator":{"type":"boolean","nullable":true,"description":"Whether automatic payment is enabled for this policy"}}}}}} ``` ### Off-Exchange Plans ## POST /your-endpoint-url > ```json {"openapi":"3.0.0","info":{"title":"Policy Status - Off-Ex","version":"1.0.0"},"paths":{"/your-endpoint-url":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OffExPolicyStatusPayload"}}}},"responses":{"200":{"description":"Successful response"}}}}},"components":{"schemas":{"OffExPolicyStatusPayload":{"type":"object","properties":{"transaction_id":{"type":"integer","description":"Unique identifier for the transaction (confirmation ID)"},"application_id":{"type":"string","description":"Canonical identifier for the off-exchange application"},"policy_status":{"type":"string","description":"Current status of the active health policy","enum":["effectuated","cancelled","terminated"]},"event_type":{"type":"string","description":"Type of event that triggered the webhook","enum":["sync"]},"event_timestamp":{"type":"string","description":"Date when the application was last submitted (MM/DD/YYYY format)"},"external_id":{"type":"string","description":"External identifier for the enrollment lead"},"policy_aor_npn":{"type":"string","description":"National Producer Number of the Agent of Record on the policy"},"submitter_npn":{"type":"string","description":"National Producer Number of the agent who submitted the application"},"npn_used_at_submission":{"type":"string","description":"NPN recorded at the time of submission"},"issuer_hios_id":{"type":"string","description":"HIOS ID of the insurance issuer"},"issuer_member_id":{"type":"string","nullable":true,"description":"Carrier-assigned member ID from the primary health policy's external policy record. Null if the carrier has not yet assigned or shared a member ID."},"members":{"type":"array","description":"List of members/applicants in the application","items":{"$ref":"#/components/schemas/Member"}},"policies":{"type":"array","description":"List of policies associated with the application","items":{"$ref":"#/components/schemas/Policy"}}}},"Member":{"type":"object","properties":{"member_id":{"type":"string","description":"Unique identifier for the member"},"first_name":{"type":"string","description":"Member's first name"},"last_name":{"type":"string","description":"Member's last name"},"date_of_birth":{"type":"string","description":"Member's date of birth (MM/DD/YYYY format)"}}},"Policy":{"type":"object","properties":{"policy_id":{"type":"string","description":"Canonical identifier for the policy"},"effective_date":{"type":"string","description":"Date when the policy becomes effective (MM/DD/YYYY format)"},"expiration_date":{"type":"string","description":"Date when the policy expires (MM/DD/YYYY format)"},"status":{"type":"string","description":"Current status of the policy","enum":["effectuated","cancelled","terminated"]},"plan_hios_id":{"type":"string","description":"HIOS ID of the insurance plan"},"gross_premium":{"type":"number","format":"float","description":"Gross premium amount for the policy"},"members":{"type":"array","description":"List of members covered by this policy","items":{"$ref":"#/components/schemas/PolicyMember"}},"agent_of_record":{"$ref":"#/components/schemas/AgentOfRecord"},"payment":{"$ref":"#/components/schemas/Payment"},"issuer_member_id":{"type":"string","nullable":true,"description":"Carrier-assigned member ID for this specific policy. Null if the carrier has not yet assigned or shared a member ID."}}},"PolicyMember":{"type":"object","properties":{"member_id":{"type":"string","description":"Reference to member ID in the members array"},"effective_date":{"type":"string","description":"Date when coverage begins for this member (MM/DD/YYYY format)"},"removed_date":{"type":"string","nullable":true,"description":"Date when coverage ends for this member, if applicable (MM/DD/YYYY format)"}}},"AgentOfRecord":{"type":"object","properties":{"npn":{"type":"string","description":"National Producer Number of the agent"},"first_name":{"type":"string","description":"Agent's first name"},"last_name":{"type":"string","description":"Agent's last name"},"state_license_number":{"type":"string","description":"Agent's state license number"},"email":{"type":"string","format":"email","description":"Agent's email address"}}},"Payment":{"type":"object","nullable":true,"description":"Payment information for a policy. The payment key is always present (set to null if no payment data is available).\n","properties":{"payment_status":{"type":"string","enum":["unpaid_binder","paid_binder","paid","past_due"],"description":"Current payment status of the policy"},"payment_status_updated_date":{"type":"string","nullable":true,"description":"Date when payment status was last updated (MM/DD/YYYY format)"},"grace_period_start_date":{"type":"string","nullable":true,"description":"Start date of grace period, if applicable (MM/DD/YYYY format)"},"paid_through_date":{"type":"string","nullable":true,"description":"Date through which the policy is paid (MM/DD/YYYY format)"},"past_due_member_responsibility_balance_due":{"type":"string","description":"Past due balance amount (decimal string with 2 decimal places, e.g., \"150.00\")"},"current_member_responsibility_balance_due":{"type":"string","description":"Current balance amount (decimal string with 2 decimal places, e.g., \"50.50\")"},"autopay_indicator":{"type":"boolean","nullable":true,"description":"Whether automatic payment is enabled for this policy"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ichra.healthsherpa.com/api-reference/webhooks-api/policy-status-api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.