How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zywave ETL after Policy API

When importing data via the API, these operations should be performed after the referenced policy has been created.

Zywave ETL after Policy API is one of 84 APIs that Zywave publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 60 JSON Schema definitions.

Tagged areas include ETL after Policy. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 60 JSON Schemas.

This API exposes 9 operations across 9 paths, and defines 38 schemas. It is described by OpenAPI 3.2.0, at version v2.0.

Requests are made against a single base URL, https://api.zywave.com.

9 operations 9 paths 38 schemas 7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2.0
Base URL
https://api.zywave.com
Authentication
OpenID Connect
Resource Areas
1

Authentication & Security 1

Zywave ETL after Policy API declares 1 security scheme for authenticating requests. It supports OpenID Connect (oidc) discovered at https://auth.zywave.com/.well-known/openid-configuration. By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

ETL after Policy 9

When importing data via the API, these operations should be performed after the referenced policy has been created.

POST
/policies/v2.0/policies/{policyId}/commissionbillings
Creates a commission billing for a policy
CommissionBillings_PostCommissionBillingFromPolicy 1 param body → 201400401403
POST
/policies/v2.0/policies/{policyId}/fixedrates
Creates a fixed rate for a policy
FixedRates_PostFixedRateFromPolicy 1 param body → 201400401403
PUT
/policies/v2.0/policies/{id}/cobrastrategies
Inserts or updates a COBRA rate strategy
Policies_UpsertCobraStrategy 1 param body → 201200400401403
POST
/policies/v2.0/policies/{policyId}/commissionperiods
Creates, updated, or deletes a Commission Period for a policy based on the…
Policies_PostCommissionPeriod 1 param body → 201204400404401403
PUT
/policies/v2.0/policies/{id}/contributionstrategies
Inserts or updates a contribution strategy
Policies_UpsertContributionStrategy 1 param body → 201204400401403
POST
/policies/v2.0/policies/{policyId}/eligibilities
Creates an eligibility record for the policy
Policies_CreateEligibility 1 param body → 201401403404
POST
/policies/v2.0/policies/{policyId}/fees
Creates a fee for a policy
Policies_PostFee 1 param body → 201400401403
POST
/policies/v2.0/policies/{policyId}/volumerates
Creates a VolumeRate record for the policy
Policies_CreateVolumeRate 1 param body → 201401403404
POST
/policies/v2.0/policies/{policyId}/tieredrates
Creates a tiered rate for a policy
TieredRates_PostTieredRateFromPolicy 1 param body → 201400401403

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are CommissionBillingBaseInfo (13 properties), EligibilityInfo (11 properties), VolumeRateInfo (7 properties), FeeInfo (5 properties). Each schema is shown below with its type and property counts.

VolumeRateInfo
object
Volume rate create/update data
7 properties 5 required
ContributionStrategyInfo
object
2 properties 2 required
CommissionTypeOption
string
FixedRateFrequencyOption
string
CommissionCalculationStrategyOption
string
FixedRate
CobraRateStrategyInfo
object
A COBRA strategy record
2 properties
FeeInfo
object
Fee info
5 properties 2 required
CobraRateRecord
EntityActionOption
string
CobraRateRecordInfo
object
COBRA rate record info
1 property
VolumeRate
ContributionRoundingStrategyOption
string
FixedRateBaseInfo
object
3 properties 1 required
ContributionStrategyUpdateInfo
TieredRateBaseInfo
object
3 properties 1 required
EmployeeGroupOptions
string
ContributionCalculationStrategyOption
string
CommissionBillingBaseInfo
object
13 properties 3 required
RateTierTypeOption
string
ProblemDetails
object
5 properties
CoverageTerminationOption
string
DeltaOfCommissionPeriodInfo
object
A wrapper for values to be used for updating or creating a record.
1 property
CobraRateStrategy
VolumeAmountTypeOption
string
CommissionPeriodInfo
object
Information used when creating or updating a CommissionPeriod. All values are required when used for creation.
3 properties
CobraRateOption
string
CommissionRoundingStrategyOption
string
EligibilityInfo
object
Eligibility information for a policy.
11 properties
HttpValidationProblemDetails
FrequencyOption
string
WaitingPeriodOption
string
AuditInfoOfCommissionPeriodInfo
object
3 properties 1 required
FixedRateInfo
VolumeRates
object
An array of volume rates with the total premium for all.
3 properties
CommissionPeriodAuditInfo
ValidationProblemDetails
CobraRatesWithStrategy
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zywave-etl-after-policy-api-openapi.yml Raw ↑

Other APIs Zywave publishes across the network.

Zywave Account API
Zywave Account Contact API
Zywave Account Contact Driver API
Zywave Account Contacts API
Zywave Account External Reference API
Zywave Accounts API
Zywave Activation API
Zywave Activities API
Zywave Agency API
Zywave Agency Data API
Zywave Agency User API
Zywave Assessment API
Where this information came from

This is an independent, third-party profile of Zywave ETL after Policy API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.