IVANS Enhanced Appetite API

The enhanced-appetite API from IVANS — 1 operation(s) for enhanced-appetite.

Operations 1

POST /api/v1/enhanced-appetite/ Enhanced appetite create #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-risk-profile-read-only-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-insurance-license-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-enhanced-appetite-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-agent-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-basic-appetite-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-agent-write-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-body-auth0-token-api-v1-identity-auth0-token-post-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-fast-path-submission-request-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-risk-profile-diff-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-submission-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-auto-field-options-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-classic-quote-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-submission-request-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-file-content-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-bookroll-request-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-agency-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-consumer-info-registration-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-connection-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-file-metadata-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-file-with-content-type-and-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-producer-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-partner-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-carrier-naic-group-v2-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-file-paginated-filtered-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-record-count-result-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-claims-download-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-edoc-req-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-document-store-req-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-document-meta-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-edoc-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/ivans/json-schema/ivans-csv-response-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/ivans:ivans-enhanced-appetite-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

ivans-enhanced-appetite-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Identification Network Enhanced Appetite API
  version: 1.0.0
  description: IVANS Identification Network API
servers:
- url: https://distribution-staging.ivansinsurance.com
tags:
- name: enhanced-appetite
paths:
  /api/v1/enhanced-appetite/:
    post:
      operationId: enhanced_appetite_create
      description: 'Returns enhanced appetite result and optional form.


        Enhanced appetite result has status for each requested combination of markets, lobs, and states.

        - If no markets are requested, appetite status is returned for all allowed markets.

        - If no states are requested, appetite status is returned for all US states.


        Optional form contains:

        - basic appetite fields

        - enhanced appetite fields for risk profiles in basic appetite

        - risk information fields for risk profiles in enhanced appetite

        - available risk profiles: list of risk profiles that passed basic and enhanced appetite,

        and that have the highest priority route for their respective product'
      parameters:
      - in: query
        name: nested_form
        schema:
          type: boolean
        description: Format the returned form with nested pages, groups, and fields
      - in: query
        name: return_form
        schema:
          type: boolean
        description: Return a form with risk information fields for markets in appetite
      tags:
      - enhanced-appetite
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnhancedAppetiteRequest'
            examples:
              StandardExample:
                value:
                  lobs:
                  - BOP
                  - WORK
                  markets:
                  - 7eeb51e5-6e68-4ca9-b85f-661f31a157b0
                  - c780e6d1-e89e-4a5d-8942-d43536e39092
                  naicsIndex: e99fe5c4-01c8-433e-8e4a-d134a6a8a66e
                  states:
                  - AL
                  - AK
                  fieldValues:
                  - questionId: 800c6507-cbcb-45da-8339-d4a0d14da02f
                    value: 1
                  - questionId: d5f471a5-d93f-41e2-ad9e-9b3c8b015617
                    value: 10
                  - questionId: 134abdcd-011f-408c-8ea5-464fa8ae7e44
                    value: 500000
                  - questionId: e0c0b4cb-48a2-4f1e-bc75-20b6f4d81589
                    value: 1
                  - questionId: 57d1c3fe-4fe6-4778-b07b-57b9587d5fff
                    value: 'No'
                  - questionId: 7c93426f-33cb-4761-bada-7b5ea0eeb1bf
                    value: 500000
                  - questionId: d4794e2f-c883-4ab4-9dab-097968fe1bba
                    value: 500000
                summary: Standard example
                description: The most common scenario is to use ACORD codes for lobs, UUIDs for markets, UUID for naicsIndex, and ISO alpha-2 codes for states. fieldValues is a list of dictionaries, in which questionId is the UUID of a form field and value is the answer to the field. For enhanced appetite, these fields should pull from the eligibility questions returned in the basic appetite endpoint (if return_form was true).
              UseUUIDsForLOBsAndStates:
                value:
                  lobs:
                  - 2bc95bf9-cf44-40fe-9d83-c7054bf4cc49
                  - 856f8ab3-761b-4899-b305-67a43ab92267
                  markets:
                  - 7eeb51e5-6e68-4ca9-b85f-661f31a157b0
                  - c780e6d1-e89e-4a5d-8942-d43536e39092
                  naicsIndex: e99fe5c4-01c8-433e-8e4a-d134a6a8a66e
                  states:
                  - 4fafb949-e1c7-498d-8429-808ae7bd18dc
                  - 2cde8afd-4b3c-44c0-89a7-492fc0e7addd
                  fieldValues:
                  - questionId: 800c6507-cbcb-45da-8339-d4a0d14da02f
                    value: 1
                  - questionId: d5f471a5-d93f-41e2-ad9e-9b3c8b015617
                    value: 10
                  - questionId: 134abdcd-011f-408c-8ea5-464fa8ae7e44
                    value: 500000
                  - questionId: e0c0b4cb-48a2-4f1e-bc75-20b6f4d81589
                    value: 1
                  - questionId: 57d1c3fe-4fe6-4778-b07b-57b9587d5fff
                    value: 'No'
                  - questionId: 7c93426f-33cb-4761-bada-7b5ea0eeb1bf
                    value: 500000
                  - questionId: d4794e2f-c883-4ab4-9dab-097968fe1bba
                    value: 500000
                summary: Use UUIDs for LOBs and states
                description: UUIDs can be used instead of codes for lobs and states
              Use6-digitCodeForNAICS:
                value:
                  lobs:
                  - BOP
                  - WORK
                  markets:
                  - 7eeb51e5-6e68-4ca9-b85f-661f31a157b0
                  - c780e6d1-e89e-4a5d-8942-d43536e39092
                  naicsIndex: '236118'
                  states:
                  - AL
                  - AK
                  fieldValues:
                  - questionId: 800c6507-cbcb-45da-8339-d4a0d14da02f
                    value: 1
                  - questionId: d5f471a5-d93f-41e2-ad9e-9b3c8b015617
                    value: 10
                  - questionId: 134abdcd-011f-408c-8ea5-464fa8ae7e44
                    value: 500000
                  - questionId: e0c0b4cb-48a2-4f1e-bc75-20b6f4d81589
                    value: 1
                  - questionId: 57d1c3fe-4fe6-4778-b07b-57b9587d5fff
                    value: 'No'
                  - questionId: 7c93426f-33cb-4761-bada-7b5ea0eeb1bf
                    value: 500000
                  - questionId: d4794e2f-c883-4ab4-9dab-097968fe1bba
                    value: 500000
                summary: Use 6-digit code for NAICS
                description: 6-digit national industry code can be used instead of UUID for naicsIndex. A market is considered in appetite if at least one of the NAICS indexes under the national industry is in appetite.
              ExcludeStates:
                value:
                  lobs:
                  - BOP
                  - WORK
                  markets:
                  - 7eeb51e5-6e68-4ca9-b85f-661f31a157b0
                  - c780e6d1-e89e-4a5d-8942-d43536e39092
                  naicsIndex: e99fe5c4-01c8-433e-8e4a-d134a6a8a66e
                  fieldValues:
                  - questionId: 800c6507-cbcb-45da-8339-d4a0d14da02f
                    value: 1
                  - questionId: d5f471a5-d93f-41e2-ad9e-9b3c8b015617
                    value: 10
                  - questionId: 134abdcd-011f-408c-8ea5-464fa8ae7e44
                    value: 500000
                  - questionId: e0c0b4cb-48a2-4f1e-bc75-20b6f4d81589
                    value: 1
                  - questionId: 57d1c3fe-4fe6-4778-b07b-57b9587d5fff
                    value: 'No'
                  - questionId: 7c93426f-33cb-4761-bada-7b5ea0eeb1bf
                    value: 500000
                  - questionId: d4794e2f-c883-4ab4-9dab-097968fe1bba
                    value: 500000
                summary: Exclude states
                description: States can be excluded from the request. Appetite will be evaluated for all US states.
              ExcludeMarkets:
                value:
                  lobs:
                  - BOP
                  - WORK
                  naicsIndex: e99fe5c4-01c8-433e-8e4a-d134a6a8a66e
                  fieldValues:
                  - questionId: 800c6507-cbcb-45da-8339-d4a0d14da02f
                    value: 1
                  - questionId: d5f471a5-d93f-41e2-ad9e-9b3c8b015617
                    value: 10
                  - questionId: 134abdcd-011f-408c-8ea5-464fa8ae7e44
                    value: 500000
                  - questionId: e0c0b4cb-48a2-4f1e-bc75-20b6f4d81589
                    value: 1
                  - questionId: 57d1c3fe-4fe6-4778-b07b-57b9587d5fff
                    value: 'No'
                  - questionId: 7c93426f-33cb-4761-bada-7b5ea0eeb1bf
                    value: 500000
                  - questionId: d4794e2f-c883-4ab4-9dab-097968fe1bba
                    value: 500000
                summary: Exclude markets
                description: Markets can be excluded from the request. Appetite will be evaluated for all markets accesssible to the user.
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EnhancedAppetiteRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EnhancedAppetiteRequest'
        required: true
      security:
      - oauth2:
        - write
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Response(nestedForm=false,ReturnForm=false):
                  value: "{\n    \"enhancedAppetite\": {\n        \"market.uuid\": {\n            \"BOP\": {\n                \"AL\": \"Available\",\n                \"WA\": \"Not in Appetite\"\n            },\n            \"WORK\": {\n                \"AL\": \"Available\",\n                \"WA\": \"Not in Appetite\"\n            }\n        },\n        \"market2.uuid\": {\n            \"BOP\": {\n                \"AL\": \"Available\",\n                \"WA\": \"Not in Appetite\"\n            },\n            \"WORK\": {\n                \"AL\": \"Available\",\n                \"WA\": \"Not in Appetite\"\n            }\n        }\n    }\n}"
                  summary: Response (nested_form=false, return_form=false)
                Response(nestedForm=false,ReturnForm=true):
                  value:
                    enhancedAppetite:
                      market.uuid:
                        BOP:
                          AL: Available
                          WA: Not in Appetite
                        WORK:
                          AL: Available
                          WA: Not in Appetite
                      market2.uuid:
                        BOP:
                          AL: Available
                          WA: Not in Appetite
                        WORK:
                          AL: Available
                          WA: Not in Appetite
                    form:
                      pages:
                      - guid: string
                        label: string
                        description: string
                        order: 2147483647
                      groups:
                      - guid: string
                        page: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        label: string
                        description: string
                        isRepeatable: true
                        repeatMinMax: ''
                        order: 2147483647
                        type: normal
                        columns:
                        - guid: string
                        parent: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        parentLabel: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        parentColumns:
                          guid: string
                      fields:
                        guid: string
                        group: string
                        label: string
                        description: string
                        additionalDetails:
                          heading: string
                          children:
                          - heading: string
                            children:
                            - listItem: string
                        order: 0
                        type: string
                        dataClass: string
                        options:
                          label: string
                          value: 0
                        underwritingCategory: string
                        isAppetiteCategory: true
                        isEnhancedAppetiteCategory: true
                        isBind: true
                        isRefer: true
                        conditions:
                          operator: and
                          action: referral
                          conditions:
                          - operator: ==
                            value: string
                            attribute: string
                            repeatingOperator: ANY
                            sourceGroup: string
                        actionConditions:
                          operator: and
                          action: referral
                          conditions:
                          - operator: ==
                            value: string
                            attribute: string
                            repeatingOperator: ANY
                            sourceGroup: string
                        market: string
                        classificationStandardGuid: string
                        classCodeFilterFieldsGuids:
                        - string
                        unique: true
                        uniqueToParent: true
                        parentAttributeGuid: string
                        prefillSourceFieldGuid: string
                        minimum: 0
                        maximum: 0
                        isSuggestable: true
                        length: 0
                      marketFields:
                      - market: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        riskProfiles:
                        - 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        fields:
                        - uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          requirementLevel: string
                        repeatableGroups:
                        - uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          description: string
                          requirementLevel: string
                          conditions: null
                          actionConditionSets: null
                          risk_profile: 6434827e-903d-4bdd-b213-d1b8bad56060
                      availableRiskProfiles:
                      - uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        name: string
                        market: string
                        marketId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        lob: string
                        route:
                          routeType: string
                          requiredToSubmit:
                            contractCode: true
                            username: true
                            password: true
                          bindAllowed: true
                          referAllowed: true
                  summary: Response (nested_form=false, return_form=true)
                Response(nestedForm=true,ReturnForm=true):
                  value:
                    enhancedAppetite:
                      market.uuid:
                        BOP:
                          AL: Available
                          WA: Not in Appetite
                        WORK:
                          AL: Available
                          WA: Not in Appetite
                      market2.uuid:
                        BOP:
                          AL: Available
                          WA: Not in Appetite
                        WORK:
                          AL: Available
                          WA: Not in Appetite
                    form:
                      pages:
                      - guid: string
                        label: string
                        description: string
                        order: 2147483647
                        groups:
                        - guid: string
                          page: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          label: string
                          description: string
                          isRepeatable: true
                          repeatMinMax: ''
                          order: 2147483647
                          type: normal
                          columns:
                          - guid: string
                          parent: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          parentLabel: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          parentColumns:
                            guid: string
                          fields:
                            guid: string
                            group: string
                            label: string
                            description: string
                            additionalDetails:
                              heading: string
                              children:
                              - heading: string
                                children:
                                - listItem: string
                            order: 0
                            type: string
                            dataClass: string
                            options:
                              label: string
                              value: 0
                            underwritingCategory: string
                            isAppetiteCategory: true
                            isEnhancedAppetiteCategory: true
                            isBind: true
                            isRefer: true
                            conditions:
                              operator: and
                              action: referral
                              conditions:
                              - operator: ==
                                value: string
                                attribute: string
                                repeatingOperator: ANY
                                sourceGroup: string
                            actionConditions:
                              operator: and
                              action: referral
                              conditions:
                              - operator: ==
                                value: string
                                attribute: string
                                repeatingOperator: ANY
                                sourceGroup: string
                            market: string
                            classificationStandardGuid: string
                            classCodeFilterFieldsGuids:
                            - string
                            unique: true
                            uniqueToParent: true
                            parentAttributeGuid: string
                            prefillSourceFieldGuid: string
                            minimum: 0
                            maximum: 0
                            isSuggestable: true
                            length: 0
                      marketFields:
                      - market: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        riskProfiles:
                        - 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        fields:
                        - uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          requirementLevel: string
                        repeatableGroups:
                        - uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                          description: string
                          requirementLevel: string
                          conditions: null
                          actionConditionSets: null
                          risk_profile: 6434827e-903d-4bdd-b213-d1b8bad56060
                      availableRiskProfiles:
                      - uuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        name: string
                        market: string
                        marketId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                        lob: string
                        route:
                          routeType: string
                          requiredToSubmit:
                            contractCode: true
                            username: true
                            password: true
                          bindAllowed: true
                          referAllowed: true
                  summary: Response (nested_form=true, return_form=true)
          description: Successfully received the appetite response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/en_appetite_invalid_body_request'
          description: Invalid request body (possible bad requests below).
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Invalid:
                  value:
                    details: Authentication credentials were not provided.
                Expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                    - tokenClass: AccessToken
                      tokenType: access
                      message: Token is invalid or expired
          description: Invalid or Expired token.
      summary: Enhanced appetite create
      x-summary-source: derived
components:
  schemas:
    FieldValuesRequest:
      type: object
      properties:
        questionId:
          type: string
          minLength: 1
        value:
          type:
          - string
          - 'null'
      required:
      - questionId
      - value
    EnhancedAppetiteRequest:
      type: object
      description: 'Returns enhanced appetite result and optional form.


        Enhanced appetite result has status for each requested combination of markets, lobs, and states.

        - If no markets are requested, appetite status is returned for all allowed markets.

        - If no states are requested, appetite status is returned for all US states.


        Optional form contains:

        - basic appetite fields

        - enhanced appetite fields for risk profiles in basic appetite

        - risk information fields for risk profiles in enhanced appetite


        ViewSet: EnhancedAppetiteViewset


        Endpoint: /enhanced-appetite/'
      properties:
        lobs:
          type: array
          items:
            type: string
        markets:
          type: array
          items:
            type: string
            format: uuid
        naicsIndex:
          type: string
        states:
          type: array
          items:
            type: string
            default: null
          default:
          - AL
          - AK
          - AS
          - AZ
          - AR
          - AA
          - AE
          - AP
          - CA
          - CO
          - CT
          - DE
          - DC
          - FL
          - GA
          - GU
          - HI
          - ID
          - IL
          - IN
          - IA
          - KS
          - KY
          - LA
          - ME
          - MD
          - MA
          - MI
          - MN
          - MS
          - MO
          - MT
          - NE
          - NV
          - NH
          - NJ
          - NM
          - NY
          - NC
          - ND
          - MP
          - OH
          - OK
          - OR
          - PA
          - PR
          - RI
          - SC
          - SD
          - TN
          - TX
          - UT
          - VT
          - VI
          - VA
          - WA
          - WV
          - WI
          - WY
        fieldValues:
          type: array
          items:
            $ref: '#/components/schemas/FieldValuesRequest'
      required:
      - fieldValues
      - lobs
      - naicsIndex
    en_appetite_invalid_body_request:
      type: object
      properties:
        lobs:
          type: array
          items: {}
          default:
          - Required or Invalid
        markets:
          type: array
          items: {}
          default:
          - Invalid
        naicsIndex:
          type: string
          default: Required or Invalid
        states:
          type: array
          items: {}
          default:
          - Invalid
        fieldValues:
          type: array
          items: {}
          default:
          - Required or Invalid
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    oauth2:
      type: oauth2
      flows:
        password:
          tokenUrl: /api/v1/token/
          refreshUrl: /api/v1/token/
          scopes:
            read: Read scope
            write: Write scope
            epic: Epic User
            third-party: Third Party User
    basicAuth:
      type: http
      scheme: basic
x-readme:
  explorer-enabled: true
  proxy-enabled: true
x-provenance:
  method: searched
  source: https://api.ivans.com/reference/agencies_list
  generated: '2026-10-13'
  note: Assembled verbatim from the OpenAPI definition fragments IVANS embeds in each operation page of its ReadMe developer portal (api.ivans.com/reference); paths and components merged per API, nothing authored.