Zywave Assessment API

The Assessment API from Zywave — 4 operation(s) for assessment.

Operations 4

POST /commercialpolicybenchmark/v2.0/assessment/gettotallosscount GetTotalLossCount endpoint #
POST /commercialpolicybenchmark/v2.0/assessment/gettotalprogramcount GetTotalProgramCount endpoint #
POST /commercialpolicybenchmark/v2.0/assessment/getassessmentdata GetAssessmentData endpoint #
POST /commercialpolicybenchmark/v2.0/assessment/getrpmdistributiondata GetRpmDistributionData endpoint #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-account-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-external-reference-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-contact-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-driver-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-contact-driver-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-agency-user-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-agency-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-agency-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-agency-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-agency-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-activity-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-carrier-contact-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-commission-schedule-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-broker-contact-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-plan-rate-metadata-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-file-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-carrier-company-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-carrier-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-carrier-company-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-carrier-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-invite-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-employee-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-tool-package-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-employee-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-tool-package-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-employee-group-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-company-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-loss-event-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-company-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-program-assessment-search-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-loss-event-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-rpm-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-download-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-content-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-content-aggregation-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-content-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-recommended-content-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-file-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-welfare-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-commercial-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-commercial-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-company-contacts-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-company-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-feature-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-license-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-feature-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-license-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-feature-license-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-user-principal-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-user-principal-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-quote-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-refresh-quote-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-search-result-of-quoted-plan-with-member-rates-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-search-result-of-coverage-group-quoted-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-search-result-of-plan-with-rates-schema.json
📊
JSONSchema
https://artifacts.apis.io/zywave/json-schema/zywave-policy-info-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/zywave:zywave-assessment-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zywave-assessment-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: CommercialPolicyBenchmark Assessment API
  version: v2.0
servers:
- url: https://api.zywave.com
security:
- oidc:
  - api.commercialpolicybenchmark
  - api.commercialpolicybenchmark:read
tags:
- name: Assessment
paths:
  /commercialpolicybenchmark/v2.0/assessment/gettotallosscount:
    post:
      tags:
      - Assessment
      summary: GetTotalLossCount endpoint
      operationId: Assessment_GetTotalLossCount
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LossAssessmentSearchRequest'
            example:
              ClientLimit: null
              MostRecentLossYear: null
              OldestLossYear: null
              Naics: null
              CoverageId: 0
              LineOfBusinessId: null
              ExposureType: null
              ExposureRangeLow: 0.0
              ExposureRangeHigh: 0.0
              OrganizationType: null
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /commercialpolicybenchmark/v2.0/assessment/gettotalprogramcount:
    post:
      tags:
      - Assessment
      summary: GetTotalProgramCount endpoint
      operationId: Assessment_GetTotalProgramCount
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProgramAssessmentSearchRequest'
            example:
              OldestTrailing: 0
              NewestTrailing: 0
              Premium: 0.0
              Limit: 0.0
              Retention: 0.0
              Naics: null
              CoverageId: 0
              LineOfBusinessId: null
              ExposureType: null
              ExposureRangeLow: 0.0
              ExposureRangeHigh: 0.0
              OrganizationType: null
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /commercialpolicybenchmark/v2.0/assessment/getassessmentdata:
    post:
      tags:
      - Assessment
      summary: GetAssessmentData endpoint
      operationId: Assessment_GetAssessmentData
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProgramAssessmentSearchRequest'
            example:
              OldestTrailing: 0
              NewestTrailing: 0
              Premium: 0.0
              Limit: 0.0
              Retention: 0.0
              Naics: null
              CoverageId: 0
              LineOfBusinessId: null
              ExposureType: null
              ExposureRangeLow: 0.0
              ExposureRangeHigh: 0.0
              OrganizationType: null
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentData'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /commercialpolicybenchmark/v2.0/assessment/getrpmdistributiondata:
    post:
      tags:
      - Assessment
      summary: GetRpmDistributionData endpoint
      operationId: Assessment_GetRpmDistributionData
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProgramAssessmentSearchRequest'
            example:
              OldestTrailing: 0
              NewestTrailing: 0
              Premium: 0.0
              Limit: 0.0
              Retention: 0.0
              Naics: null
              CoverageId: 0
              LineOfBusinessId: null
              ExposureType: null
              ExposureRangeLow: 0.0
              ExposureRangeHigh: 0.0
              OrganizationType: null
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RpmData'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    ProgramAssessmentSearchRequest:
      allOf:
      - $ref: '#/components/schemas/AssessmentSearchRequest'
      - type: object
        description: ProgramAssessmentSearchRequest class.
        additionalProperties: false
        properties:
          oldestTrailing:
            type: integer
            description: 'Default value is 24.

              OldestTrailing property.'
            format: int32
            default: 24
          newestTrailing:
            type: integer
            description: 'Default value is 0.

              NewestTrailing property.'
            format: int32
            default: 0
          premium:
            type: number
            description: 'Default value is 0.

              Premium property.'
            format: decimal
            default: 0
          limit:
            type: number
            description: 'Default value is 0.

              Limit property.'
            format: decimal
            default: 0
          retention:
            type: number
            description: 'Default value is 0.

              Retention property.'
            format: decimal
            default: 0
    Bands:
      type: object
      description: Bands class.
      additionalProperties: false
      properties:
        bandSeq:
          type: integer
          description: BandSeq property.
          format: int32
        bandDescription:
          type:
          - string
          - 'null'
          description: BandDescription property.
        programCount:
          type: integer
          description: ProgramCount property.
          format: int32
    AssessmentData:
      type: object
      description: AssessmentData class.
      additionalProperties: false
      properties:
        limitDistribution:
          description: LimitDistribution property.
          oneOf:
          - $ref: '#/components/schemas/DistributionData'
        premiumDistribution:
          description: PremiumDistribution property.
          oneOf:
          - $ref: '#/components/schemas/DistributionData'
        retentionDistribution:
          description: RetentionDistribution property.
          oneOf:
          - $ref: '#/components/schemas/DistributionData'
    LossAssessmentSearchRequest:
      allOf:
      - $ref: '#/components/schemas/AssessmentSearchRequest'
      - type: object
        description: LossAssessmentSearchRequest class.
        additionalProperties: false
        properties:
          clientLimit:
            type:
            - number
            - 'null'
            description: 'Default value is 0.

              ClientLimit nullable property.'
            format: decimal
            default: 0
          mostRecentLossYear:
            type:
            - integer
            - 'null'
            description: MostRecentLossYear nullable property.
            format: int32
          oldestLossYear:
            type:
            - integer
            - 'null'
            description: OldestLossYear nullable property.
            format: int32
    DistributionData:
      type: object
      description: DistributionData class.
      additionalProperties: false
      properties:
        chartDescription:
          type:
          - string
          - 'null'
          description: ChartDescription property.
        bands:
          type:
          - array
          - 'null'
          description: Bands property.
          items:
            $ref: '#/components/schemas/Bands'
    AssessmentSearchRequest:
      type: object
      description: AssessmentSearchRequest class.
      additionalProperties: false
      properties:
        naics:
          type:
          - array
          - 'null'
          description: 'BindRequired.

            Naics property.'
          items:
            type: string
        coverageId:
          type: integer
          description: 'BindRequired.

            CoverageId property.'
          format: int32
        lineOfBusinessId:
          type:
          - array
          - 'null'
          description: 'BindRequired.

            LineOfBusinessId property.'
          items:
            type: integer
            format: int32
        exposureType:
          type:
          - string
          - 'null'
          description: 'BindRequired.

            Default value is "Revenues".

            ExposureType property.'
          default: Revenues
        exposureRangeLow:
          type: number
          description: 'BindRequired.

            ExposureRangeLow property.'
          format: decimal
        exposureRangeHigh:
          type: number
          description: 'BindRequired.

            ExposureRangeHigh property.'
          format: decimal
        organizationType:
          type:
          - array
          - 'null'
          description: OrganizationType property.
          default: All
          items:
            type: string
    RpmData:
      type: object
      description: RpmData class.
      additionalProperties: false
      properties:
        firstQuartile:
          type: number
          description: firstQuartile property.
          format: float
        median:
          type: number
          description: median property.
          format: float
        fourthQuartile:
          type: number
          description: fourthQuartile property.
          format: float
        maxRpm:
          type: number
          description: maxRpm property.
          format: float
        clientBar:
          type: number
          description: clientBar property.
          format: float
        nthPercent:
          type: number
          description: nthPercent property.
          format: float
        chartDescription:
          type:
          - string
          - 'null'
          description: chartDescription nullable property.
  securitySchemes:
    oidc:
      type: oauth2
      openIdConnectUrl: https://auth.zywave.com/.well-known/openid-configuration
      flows:
        authorizationCode:
          authorizationUrl: https://auth.zywave.com/connect/authorize
          tokenUrl: https://auth.zywave.com/connect/token
          scopes:
            api.commercialpolicybenchmark: Full access to all api operations
            api.commercialpolicybenchmark:read: Read-only access to api
x-generator: NSwag v14.1.0.0 (NJsonSchema v11.0.2.0 (Newtonsoft.Json v13.0.0.0))