> ## Documentation Index
> Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Rate a submission with the latest version of a market rater

> Rate one submission with the highest published version of a market rater. The response names the version that rated.

The latest version is not always the one for your policy date or transaction. To rate one version, use [Rate a submission with a market rater version](/api-reference/market-raters/rate-a-submission-with-a-market-rater-version). The request and response are the same.

Needs access to rate the rater and your `raters:run` permission. Effective example raters need only `raters:run`. Rating changes nothing, so the request is safe to repeat.



## OpenAPI

````yaml /openapi.json post /insurance/rating-programs/{id}/rate
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/rating-programs/{id}/rate:
    post:
      tags:
        - Market raters
      summary: Rate a submission with the latest version of a market rater
      description: >-
        Rate one submission with the highest published version of a market
        rater. The response names the version that rated.


        The latest version is not always the one for your policy date or
        transaction. To rate one version, use [Rate a submission with a market
        rater
        version](/api-reference/market-raters/rate-a-submission-with-a-market-rater-version).
        The request and response are the same.


        Needs access to rate the rater and your `raters:run` permission.
        Effective example raters need only `raters:run`. Rating changes nothing,
        so the request is safe to repeat.
      operationId: rateRatingProgram
      parameters:
        - schema:
            type: string
            pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
            description: The market rater’s ID, such as `effective.example-ca-ppa`.
          required: true
          description: The market rater’s ID, such as `effective.example-ca-ppa`.
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            example:
              inputs:
                Policy:
                  multi_policy: false
                  years_with_us: 0
                  drivers:
                    - number: 1
                      years_licensed: 12
                      marital_status: married
                  vehicles:
                    - number: 1
                      garaging_zip: '92683'
                      make_model: HONDA/ODYSSEY
                      vehicle_age: 7
                      annual_mileage: 12000
                      use: commute
                      bodily_injury_limit: 30/60
                      property_damage_limit: '15'
                      combined_single_limit: false
                      uninsured_motorist_property_damage: false
                      collision_deductible_waiver: false
                      roadside: false
                      loan_gap: false
                      custom_equipment_limit: 0
            schema:
              type: object
              properties:
                inputs:
                  type: object
                  additionalProperties:
                    nullable: true
              required:
                - inputs
              additionalProperties: false
      responses:
        '200':
          description: >-
            Native rating result, timings and selected version and bundle
            identity.
          content:
            application/json:
              example:
                programId: effective.example-ca-ppa
                version: 2
                raterId: effective.example-ca-ppa
                bundleId: >-
                  60dd05ba34b69f8550697d0b1fc7cca49cba8ad5060b64f7c96c9801d9de13cd
                programFingerprint: >-
                  77f601b1385daab5f00408c33422a17fc31b997ac40ac3c047e66c1879ea4d7a
                releaseVersion: 2
                result:
                  Policy:
                    drivers:
                      - incidents: []
                    vehicles:
                      - coverage_premium:
                          bodily_injury: 305
                          property_damage: 223
                          medical_payments: 0
                          uninsured_motorist_bodily_injury: 0
                          comprehensive: 0
                          collision: 0
                        endorsement_premium:
                          uninsured_motorist_property_damage: 0
                          collision_deductible_waiver: 0
                          rental: 0
                          roadside: 0
                          loan_gap: 0
                          custom_equipment: 0
                    premium: 528
                timings:
                  coldStartMs: 184.00226500001736
                  evaluateMs: 1.476
                  workerMs: 2.9333999999798834
              schema:
                $ref: '#/components/schemas/V2RatingProgramRateResult'
        '400':
          description: Invalid request or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            Your organization’s access to the rater, or your permission, is
            missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: The rater, version or package is not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            The engine that serves this version differs from the engine it
            records. Retry later; if it persists, contact Effective.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: The inputs exceed 1 MiB.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: The request body is not application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '422':
          description: >-
            invalid_inputs or business_rejection: violations lists each failed
            constraint. evaluation_failed: the engine could not rate the inputs.
          content:
            application/json:
              example:
                code: business_rejection
                error: The program doesn't cover rideshare use.
                businessCode: RIDESHARE
                violations:
                  - code: RIDESHARE
                    message: The program doesn't cover rideshare use.
                    path: Policy.vehicles[0].rideshare
                    value: true
                    constraint: 'rideshare: where not self'
                    cite: manual:anchor "eligibility"
                violationsTruncated: false
                requestId: 1793385750835-0
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Too many requests, or no rating capacity. Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: A dependency is unavailable. Retry after Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2RatingProgramRateResult:
      type: object
      properties:
        programId:
          type: string
          pattern: ^[a-z0-9][a-z0-9._-]{0,127}$
          description: The market rater’s ID, such as `effective.example-ca-ppa`.
        version:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        raterId:
          type: string
          description: The same value as `programId`.
        bundleId:
          type: string
          pattern: ^[a-f0-9]{64}$
          description: SHA-256 identity of the engine bundle that rated the submission.
        programFingerprint:
          type: string
          description: Fingerprint of the compiled rating program.
        releaseVersion:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          description: The same value as `version`.
        result:
          type: object
          additionalProperties:
            nullable: true
          description: >-
            Outputs keyed by root record, for example `{"Policy": {...}}`. The
            version contract’s outputSchema describes it. The engine computes in
            exact decimals; the API returns them as JSON numbers with 64-bit
            float precision, about 15 significant digits.
        timings:
          type: object
          properties:
            coldStartMs:
              type: number
              minimum: 0
            evaluateMs:
              type: number
              minimum: 0
            workerMs:
              type: number
              minimum: 0
            materializeMs:
              type: number
              minimum: 0
          required:
            - workerMs
          additionalProperties: false
          description: Milliseconds spent loading the engine (cold start only) and rating.
      required:
        - programId
        - version
        - raterId
        - bundleId
        - programFingerprint
        - result
        - timings
      additionalProperties: false
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            executionId:
              type: string
              description: >-
                The recorded execution of a failed rating, for rater rating
                failures.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.