Evari

Evari Quotes API

The Evari Quotes microservice - the internal broker and underwriter quoting surface at /api/quotes/** plus a customer-facing mirror at /api/quotes/public/**. 49 paths, 56 operations and 70 definitions covering quote create/read/patch, product questions, validation, pricing with first-class price errors, quote options, SMS and code confirmation, PDF issue, attachments, mid-term endorsements with a structured diff model, referral to a human underwriter with notes and cover price overrides, and per-product quote-date configuration. Auth is a single apiKey carried in the Authorization header. NOT SELF-SERVE - this spec was harvested from the Swagger document Evari bundled in its own evari-quotes-api npm tarball, not from a developer portal; the API is tenant-scoped and the only API root named in a first-party build config returns 404 unauthenticated.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/authentication/evari-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/openapi/evari-quotes-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/json-schema/evari-contracts-types.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/overlays/evari-quotes-api-overlay.yaml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/conventions/evari-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/data-model/evari-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/agentic-access/evari-agentic-access.yml
🔗
MCPServer
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/mcp/evari-mcp.yml
🔗
AgentSkill
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/skills/_index.yml
🔗
Packages
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/packages/evari-packages.yml
🔗
SourceCode
https://www.npmjs.com/package/evari-quotes-api
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/apis.yml

OpenAPI Specification

evari-quotes-api-openapi.yml Raw ↑ 
basePath: null
definitions:
    DependencyStatusResponse:
        description: ""
        properties:
            name:
                type: string
                description: ""
            ok:
                type: boolean
                description: ""
            message:
                type: string
                description: ""
        type: object
        required:
            - name
            - ok
            - message
    DiagnosticsResponse:
        description: ""
        properties:
            description:
                type: string
                description: ""
            status:
                type: string
                description: ""
            version:
                type: string
                description: ""
            dependencies:
                type: array
                items:
                    $ref: '#/definitions/DependencyStatusResponse'
                description: ""
        type: object
        required:
            - description
            - status
            - version
            - dependencies
    HealthResponse:
        description: ""
        properties:
            status:
                type: string
                description: ""
        type: object
        required:
            - status
    QuoteProduct:
        description: ""
        properties:
            id:
                type: string
                description: ""
            name:
                type: string
                description: ""
            locale:
                type: string
                description: ""
            currency:
                type: string
                description: ""
            allowAgentsToProxy:
                type: boolean
                description: ""
        type: object
        required:
            - id
            - name
            - locale
            - currency
            - allowAgentsToProxy
    QuoteAnswerResponse:
        description: ""
        properties:
            isDeclined:
                type: boolean
                description: ""
            originalAnswer:
                type: object
                description: ""
            questionId:
                type: string
                description: ""
            internalKey:
                type: string
                description: ""
            attributeId:
                type: object
                description: ""
            question:
                type: string
                description: ""
            answer:
                type: string
                description: ""
            answerLabel:
                type: string
                description: ""
        type: object
        required:
            - isDeclined
            - originalAnswer
            - questionId
            - internalKey
            - attributeId
            - question
            - answer
    QuoteCoverLimit:
        description: ""
        properties:
            id:
                type: string
                description: ""
            value:
                type: string
                description: ""
            label:
                type: string
                description: ""
            internalKey:
                type: string
                description: ""
            originalValue:
                type: string
                description: ""
        type: object
        required:
            - id
            - value
            - label
            - internalKey
            - originalValue
    PriceComponent:
        description: ""
        properties:
            name:
                type: string
                description: ""
            value:
                type: string
                description: ""
            type:
                type: string
                description: ""
            source:
                type: string
                description: ""
            target:
                type: string
                description: ""
        type: object
        required:
            - name
            - value
            - type
    PriceSummary:
        description: ""
        properties:
            premium:
                type: string
                description: ""
            totalTaxes:
                type: string
                description: ""
            totalFees:
                type: string
                description: ""
            totalPayable:
                type: string
                description: ""
        type: object
        required:
            - premium
            - totalTaxes
            - totalFees
            - totalPayable
        additionalProperties: {}
    PriceError:
        description: ""
        properties:
            message:
                type: string
                description: ""
        type: object
        required:
            - message
    QuoteCoverResponse:
        description: ""
        properties:
            isDeclined:
                type: boolean
                description: ""
            declinedReason:
                type: string
                description: ""
            isReferred:
                type: boolean
                description: ""
            referredReason:
                type: string
                description: ""
            id:
                type: string
                description: ""
            coverId:
                type: string
                description: ""
            internalKey:
                type: string
                description: ""
            label:
                type: string
                description: ""
            value:
                type: boolean
                description: ""
            limits:
                type: array
                items:
                    $ref: '#/definitions/QuoteCoverLimit'
                description: ""
            priceComponents:
                type: array
                items:
                    $ref: '#/definitions/PriceComponent'
                description: ""
            price:
                $ref: '#/definitions/PriceSummary'
            errors:
                type: array
                items:
                    $ref: '#/definitions/PriceError'
                description: ""
        type: object
        required:
            - id
            - coverId
            - internalKey
            - label
            - value
            - limits
            - priceComponents
    QuoteInterestedParty:
        description: ""
        properties:
            name:
                type: string
                description: ""
            type:
                type: string
                description: ""
            loanId:
                type: object
                description: ""
            mailingAddress:
                type: object
                description: ""
            email:
                type: object
                description: ""
            sendEmail:
                type: object
                description: ""
            description:
                type: object
                description: ""
        type: object
        required:
            - name
            - type
    QuoteResponse:
        description: ""
        properties:
            id:
                type: string
                description: ""
            createdAt:
                type: string
                description: ""
            updatedAt:
                type: string
                description: ""
            customer:
                type: object
                description: ""
            product:
                $ref: '#/definitions/QuoteProduct'
            answers:
                type: array
                items:
                    $ref: '#/definitions/QuoteAnswerResponse'
                description: ""
            covers:
                type: array
                items:
                    $ref: '#/definitions/QuoteCoverResponse'
                description: ""
            interestedParties:
                type: array
                items:
                    $ref: '#/definitions/QuoteInterestedParty'
                description: ""
            startDate:
                type: string
                description: ""
            endDate:
                type: string
                description: ""
            timezoneOffset:
                type: string
                description: ""
            expiryDate:
                type: string
                description: ""
            customerConfirmed:
                type: boolean
                description: ""
            attestations:
                type: object
                description: ""
            agentId:
                type: object
                description: ""
            locked:
                type: boolean
                description: ""
            origin:
                enum:
                    - POLICY_NEW
                    - POLICY_ENDORSEMENT
                type: string
                description: ""
            referred:
                type: boolean
                description: ""
            referredQuote:
                type: object
                description: ""
            status:
                type: string
                description: ""
            referredQuoteLocked:
                type: boolean
                description: ""
            customerProxy:
                type: object
                description: ""
            duplicateGroupId:
                type: object
                description: ""
            teamId:
                type: string
                description: ""
            triggeredUnderwritingRule:
                type: object
                description: ""
            priceComponents:
                type: array
                items:
                    $ref: '#/definitions/PriceComponent'
                description: ""
            price:
                $ref: '#/definitions/PriceSummary'
            errors:
                type: array
                items:
                    $ref: '#/definitions/PriceError'
                description: ""
        type: object
        required:
            - id
            - createdAt
            - updatedAt
            - customer
            - product
            - answers
            - covers
            - interestedParties
            - startDate
            - endDate
            - timezoneOffset
            - expiryDate
            - customerConfirmed
            - attestations
            - agentId
            - locked
            - origin
            - referred
            - referredQuote
            - status
            - referredQuoteLocked
            - customerProxy
            - duplicateGroupId
            - triggeredUnderwritingRule
            - priceComponents
    QuoteListResponse:
        description: ""
        properties:
            items:
                type: array
                items:
                    $ref: '#/definitions/QuoteResponse'
                description: ""
            limit:
                type: number
                format: double
                description: ""
            offset:
                type: number
                format: double
                description: ""
            total:
                type: number
                format: double
                description: ""
        type: object
        required:
            - items
            - limit
            - offset
            - total
    QuoteCountResponse:
        description: ""
        properties:
            count:
                type: number
                format: double
                description: ""
        type: object
        required:
            - count
    QuoteAnswerRequest:
        description: ""
        properties:
            questionId:
                type: string
                description: ""
            internalKey:
                type: string
                description: ""
            attributeId:
                type: object
                description: ""
            question:
                type: string
                description: ""
            answer:
                type: string
                description: ""
            answerLabel:
                type: string
                description: ""
        type: object
        required:
            - questionId
            - internalKey
            - attributeId
            - question
            - answer
    QuoteCoverRequest:
        description: ""
        properties:
            id:
                type: string
                description: ""
            coverId:
                type: string
                description: ""
            internalKey:
                type: string
                description: ""
            label:
                type: string
                description: ""
            value:
                type: boolean
                description: ""
            limits:
                type: array
                items:
                    $ref: '#/definitions/QuoteCoverLimit'
                description: ""
            isDeclined:
                type: boolean
                description: ""
            isReferred:
                type: boolean
                description: ""
            referredReason:
                type: string
                description: ""
        type: object
        required:
            - id
            - coverId
            - internalKey
            - label
            - value
            - limits
    QuoteCreateRequest:
        description: ""
        properties:
            customer:
                type: object
                description: ""
            product:
                type: object
                properties:
                    id:
                        type: string
                        description: ""
                description: ""
            answers:
                type: array
                items:
                    $ref: '#/definitions/QuoteAnswerRequest'
                description: ""
            covers:
                type: array
                items:
                    $ref: '#/definitions/QuoteCoverRequest'
                description: ""
            interestedParties:
                type: array
                items:
                    $ref: '#/definitions/QuoteInterestedParty'
                description: ""
            startDate:
                type: string
                description: ""
            endDate:
                type: string
                description: ""
            timezoneOffset:
                type: string
                description: ""
            attestations:
                type: object
                description: ""
            actAsCustomerProxy:
                type: boolean
                description: ""
            duplicateGroupId:
                type: string
                description: ""
            teamId:
                type: string
                description: ""
        type: object
        required:
            - product
            - answers
            - covers
    QuoteUpdateRequest:
        description: ""
        properties:
            customer:
                type: object
                description: ""
            product:
                type: object
                properties:
                    id:
                        type: string
                        description: ""
                description: ""
            answers:
                type: array
                items:
                    $ref: '#/definitions/QuoteAnswerRequest'
                description: ""
            covers:
                type: array
                items:
                    $ref: '#/definitions/QuoteCoverRequest'
                description: ""
            interestedParties:
                type: array
                items:
                    $ref: '#/definitions/QuoteInterestedParty'
                description: ""
            startDate:
                type: string
                description: ""
            endDate:
                type: string
                description: ""
            timezoneOffset:
                type: string
                description: ""
            attestations:
                type: object
                description: ""
            referredQuoteLocked:
                type: boolean
                description: ""
            actAsCustomerProxy:
                type: boolean
                description: ""
            duplicateGroupId:
                type: string
                description: ""
            teamId:
                type: string
                description: ""
        type: object
    PartialAnswerResponse:
        description: ""
        properties:
            questionId:
                type: string
                description: ""
            internalKey:
                type: string
                description: ""
            isDeclined:
                type: boolean
                description: ""
            originalAnswer:
                type: object
                description: ""
            attributeId:
                type: object
                description: ""
            question:
                type: string
                description: ""
            answer:
                type: string
                description: ""
            answerLabel:
                type: string
                description: ""
        type: object
        required:
            - questionId
            - internalKey
    PartialLimitResponse:
        description: ""
        properties:
            id:
                type: string
                description: ""
            internalKey:
                type: string
                description: ""
            value:
                type: string
                description: ""
            label:
                type: string
                description: ""
            originalValue:
                type: string
                description: ""
        type: object
        required:
            - id
            - internalKey
    PartialCoverResponse:
        description: ""
        properties:
            id:
                type: string
                description: ""
            internalKey:
                type: string
                description: ""
            limits:
                type: array
                items:
                    $ref: '#/definitions/PartialLimitResponse'
                description: ""
            label:
                type: string
                description: ""
            value:
                type: boolean
                description: ""
            isDeclined:
                type: boolean
                description: ""
            declinedReason:
                type: string
                description: ""
            isReferred:
                type: boolean
                description: ""
            referredReason:
                type: string
                description: ""
        type: object
        required:
            - id
            - internalKey
    QuoteUpdateByInternalKeyResponse:
        description: ""
        properties:
            id:
                type: string
                description: ""
            updatedAt:
                type: string
                description: ""
            customer:
                type: object
                description: ""
            product:
                $ref: '#/definitions/QuoteProduct'
            interestedParties:
                type: array
                items:
                    $ref: '#/definitions/QuoteInterestedParty'
                description: ""
            startDate:
                type: string
                description: ""
            endDate:
                type: string
                description: ""
            timezoneOffset:
                type: string
                description: ""
            expiryDate:
                type: string
                description: ""
            customerConfirmed:
                type: boolean
                description: ""
            attestations:
                type: object
                description: ""
            agentId:
                type: object
                description: ""
            locked:
                type: boolean
                description: ""
            origin:
                enum:
                    - POLICY_NEW
                    - POLICY_ENDORSEMENT
                type: string
                description: ""
            referred:
                type: boolean
                description: ""
            referredQuote:
                type: object
                description: ""
            status:
                type: string
                description: ""
            referredQuoteLocked:
                type: boolean
                description: ""
            customerProxy:
                type: object
                description: ""
            answers:
                type: array
                items:
                    $ref: '#/definitions/PartialAnswerResponse'
                description: ""
            covers:
                type: array
                items:
                    $ref: '#/definitions/PartialCoverResponse'
                description: ""
            triggeredUnderwritingRule:
                type: object
                description: ""
        type: object
        required:
            - id
            - updatedAt
    QuoteItemToUpdateByInternalKey:
        description: ""
        properties:
            internalKey:
                type: string
                description: ""
        type: object
        required:
            - internalKey
        additionalProperties: {}
    QuoteUpdateByInternalKeyRequest:
        description: ""
        properties:
            items:
                type: array
                items:
                    $ref: '#/definitions/QuoteItemToUpdateByInternalKey'
                description: ""
        type: object
        required:
            - items
    ConfirmSMS:
        description: ""
        properties:
            number:
                type: string
                description: ""
        type: object
        required:
            - number
    QuestionResponse:
        description: ""
        properties:
            id:
                type: string
                description: ""
            internalDescription:
                type: object
                description: ""
            internalKey:
                type: string
                description: ""
            label:
                type: string
                description: ""
            dataType:
                type: string
                description: ""
            dataSource:
                type: object
                description: ""
            dataLookupKey:
                type: object
                description: ""
            dataSourceType:
                type: object
                description: ""
            required:
                type: boolean
                description: ""
            minValue:
                type: object
                description: ""
            maxValue:
                type: object
                description: ""
            placeholder:
                type: string
                description: ""
            value:
                type: string
                description: ""
            options:
                type: object
                description: ""
            group:
                type: object
                description: ""
            styling:
                type: object
                description: ""
            dependencies:
                type: object
                description: ""
            helpText:
                type: object
                description: ""
            parentKey:
                type: object
                description: ""
            isCoversTrigger:
                type: boolean
                description: ""
            attributeId:
                type: object
                description: ""
            isVisible:
                type: boolean
                description: ""
            isParent:
                type: boolean
                description: ""
            isEndorsable:
                type: boolean
                description: ""
            isLocked:
                type: boolean
                description: ""
            rules:
                type: object
                description: ""
            dataSourceConfiguration:
                type: object
                description: ""
        type: object
        required:
            - id
            - internalDescription
            - internalKey
            - label
            - dataType
            - dataSource
            - dataLookupKey
            - dataSourceType
            - required
            - minValue
            - maxValue
            - placeholder
            - value
            - options
            - group
            - styling
            - dependencies
            - helpText
            - parentKey
            - isCoversTrigger
            - attributeId
            - isVisible
            - isParent
            - isEndorsable
            - isLocked
            - rules
            - dataSourceConfiguration
    QuestionResponseList:
        description: ""
        properties:
            items:
                type: array
                items:
                    $ref: '#/definitions/QuestionResponse'
                description: ""
        type: object
        required:
            - items
    AttachmentResponse:
        description: ""
        properties:
            id:
                type: string
                description: ""
            fileName:
                type: string
                description: ""
            description:
                type: object
                description: ""
        type: object
        required:
            - id
            - fileName
            - description
    Quote:
        description: ""
        properties:
            teamId:
                type: object
                description: ""
            version:
                type: number
                format: double
                description: ""
            customer:
                type: object
                description: ""
            customerConfirmed:
                type: boolean
                description: ""
            confirmationCode:
                type: object
                description: ""
            confirmationExpiration:
                type: object
                description: ""
            product:
                $ref: '#/definitions/Product'
            answers:
                type: array
                items:
                    $ref: '#/definitions/Answer'
                description: ""
            covers:
                type: array
                items:
                    $ref: '#/definitions/Cover'
                description: ""
            startDate:
                type: string
                format: date-time
                description: ""
            endDate:
                type: string
                format: date-time
                description: ""
            timezoneOffset:
                type: string
                description: ""
            expiryDate:
                type: string
                format: date-time
                description: ""
            priceStatus:
                enum:
                    - NONE
                    - CALCULATING
                    - CALCULATED
                type: string
                description: ""
            documentId:
                type: object
                description: ""
            documentStatus:
                enum:
                    - NONE
                    - GENERATING
                    - GENERATED
                type: string
                description: ""
            customerProxy:
                type: object
                description: ""
            priceComponents:
                type: array
                items:
                    $ref: '#/definitions/QuotePriceComponent'
                description: ""
            priceSummaries:
                type: array
                items:
                    $ref: '#/definitions/QuotePriceSummary'
                description: ""
            priceErrors:
                type: array
                items:
                    $ref: '#/definitions/QuotePriceError'
                description: ""
            interestedParties:
                type: array
                items:
                    $ref: '#/definitions/InterestedParty'
                description: ""
            attestationsDateTimeStamp:
                type: object
                description: ""
            attestationsAccepted:
                type: boolean
                description: ""
            agentId:
                type: object
                description: ""
            locked:
                type: boolean
                description: ""
            origin:
                enum:
                    - POLICY_NEW
                    - POLICY_ENDORSEMENT
                type: string
                description: ""
            endorsement:
                type: object
                description: ""
            referredQuote:
                type: object
                description: ""
            referredQuoteLocked:
                type: boolean
                description: ""
            externallyReferred:
                type: boolean
                description: ""
            duplicateGroupId:
                type: object
                description: ""
            referralContractText:
                type: object
                description: ""
            referralOutcomeText:
                type: object
                description: ""
            referralNotes:
                type: object
                description: ""
            referredQuoteCoverPrices:
                type: object
                description: ""
            suppressedUnderwritingRules:
                type: array
                items:
                    $ref: '#/definitions/UnderwritingRule'
                description: ""
            triggeredUnderwritingRule:
                type: object
                description: ""
            id:
                type: string
                description: ""
            createdAt:
                type: string
                format: date-time
                description: ""
            updatedAt:
                type: string
                format: date-time
                description: ""
        type: object
        required:
            - teamId
            - version
            - customer
            - customerConfirmed
            - confirmationCode
            - confirmationExpiration
            - product
            - answers
            - covers
            - startDate
            - endDate
            - timezoneOffset
            - expiryDate
            - priceStatus
            - documentId
            - documentStatus
            - customerProxy
            - priceComponents
            - priceSummaries
            - priceErrors
            - interestedParties
            - attestationsDateTimeStamp
            - attestationsAccepted
            - agentId
            - locked
            - origin
            - referredQuoteLocked
            - externallyReferred
            - duplicateGroupId
            - referralContractText
            - referralOutcomeText
            - referralNotes
            - referredQuoteCoverPrices
            - suppressedUnderwritingRules
            - id
            - createdAt
            - updatedAt
    Product:
        description: ""
        properties:
            id:
                type: string
                description: ""
            name:
                type: string
                description: ""
            locale:
                type: string
                description: ""
            currency:
                type: string
                description: ""
            quotes:
                type: array
                items:
                    $ref: '#/definitions/Quote'
                description: ""
            allowAgentsToProxy:
                type: boolean
                description: ""
            isPublic:
                type: boolean
                description: ""
            questionIds:
                type: array
                items:
                    type: string
                description: ""
            dateSettings:
                type: array
                items:
                    $ref: '#/definitions/QuoteDateSetting'
                description: ""
            timezoneSetting:
                $ref: '#/definitions/Quo

# --- truncated at 32 KB (112 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/openapi/evari-quotes-api-openapi.yml