IVANS

IVANS Basic Appetite Capture API

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

GitHub OpenAPI

Operations 1

POST /api/v1/basic-appetite-capture/ Basic appetite capture create #

Documentation

📖
APIReference
https://api.ivans.com/reference/agencies_list
📖
APIReference
https://api.ivans.com/reference/auth0_token_api_v1_identity_auth0_token__post
📖
APIReference
https://api.ivans.com/reference/get_basic_appetite_api_v1_forms_basic_appetite_get
📖
APIReference
https://api.ivans.com/reference/get_api-agencies-1
📖
APIReference
https://api.ivans.com/reference/get_api-v2-files
📖
APIReference
https://api.ivans.com/reference/get_api-v3-files
📖
APIReference
https://api.ivans.com/reference/getdocumentmetainfo
📖
APIReference
https://api.ivans.com/reference/task_status_api_v1_looker_task_status_post
📖
APIReference
https://api.ivans.com/reference/token

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ivans/openapi/ivans-basic-appetite-capture-api-openapi.yml

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-basic-appetite-capture-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.

GitHub Google LinkedIn

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

OpenAPI Specification

ivans-basic-appetite-capture-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Identification Network Basic Appetite Capture API
  version: 1.0.0
  description: IVANS Identification Network API
servers:
- url: https://distribution-staging.ivansinsurance.com
tags:
- name: basic-appetite-capture
paths:
  /api/v1/basic-appetite-capture/:
    post:
      operationId: basic_appetite_capture_create
      description: 'Returns basic appetite result, form, and possible routes.


        Second endpoint of the IDP appetite flow.


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


        Form contains:

        - basic appetite fields

        - enhanced appetite fields for risk profiles in appetite

        - available risk profiles: list of risk profiles that passed basic appetite


        Possible routes contains possible route types for each requested combination of market and lob.'
      parameters:
      - in: query
        name: nested_form
        schema:
          type: boolean
        description: Format the returned form with nested pages, groups, and fields
      tags:
      - basic-appetite-capture
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BasicAppetiteCaptureRequest'
            examples:
              StandardExample:
                value:
                  lobs:
                  - BOP
                  - WORK
                  markets:
                  - 7eeb51e5-6e68-4ca9-b85f-661f31a157b0
                  - c780e6d1-e89e-4a5d-8942-d43536e39092
                  fieldValues:
                  - questionId: f23c0847-1fce-4627-8744-b69bfdfa7b47
                    value: 24a5298c-9747-442b-8b3d-58587ee5fc08
                  - questionId: 3dcdd8fa-60f0-4352-b464-d444d91aa947
                    value: IL
                summary: Standard example
                description: The most common scenario is to use ACORD codes for lobs and UUIDs for markets. 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 basic appetite, one field should be the NAICS index, and the other should be the primary state.
              UseUUIDsForLOBs:
                value:
                  lobs:
                  - 2bc95bf9-cf44-40fe-9d83-c7054bf4cc49
                  - 856f8ab3-761b-4899-b305-67a43ab92267
                  markets:
                  - 7eeb51e5-6e68-4ca9-b85f-661f31a157b0
                  - c780e6d1-e89e-4a5d-8942-d43536e39092
                  fieldValues:
                  - questionId: f23c0847-1fce-4627-8744-b69bfdfa7b47
                    value: 24a5298c-9747-442b-8b3d-58587ee5fc08
                  - questionId: 3dcdd8fa-60f0-4352-b464-d444d91aa947
                    value: IL
                summary: Use UUIDs for LOBs
                description: UUIDs can be used instead of codes for lobs
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/BasicAppetiteCaptureRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/BasicAppetiteCaptureRequest'
        required: true
      security:
      - oauth2:
        - write
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Response(nestedForm=false):
                  value:
                    basicAppetite:
                      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
                    possibleRoutes:
                      market.uuid:
                        BOP:
                        - Quote
                        - Bridge
                        WORK:
                        - Quote
                        - Bridge
                      market2.uuid:
                        BOP:
                        - Quote
                        WORK:
                        - Quote
                  summary: Response (nested_form=false)
                Response(nestedForm=true):
                  value:
                    basicAppetite:
                      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
                    possibleRoutes:
                      market.uuid:
                        BOP:
                        - Quote
                        - Bridge
                        WORK:
                        - Quote
                        - Bridge
                      market2.uuid:
                        BOP:
                        - Quote
                        WORK:
                        - Quote
                  summary: Response (nested_form=true)
          description: Successfully received the appetite response.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/basic_appetite_capture_invalid_body_request'
          description: Invalid Request arguments or Required Arguments are missing.
        '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: Basic appetite capture create
      x-summary-source: derived
components:
  schemas:
    FieldValuesRequest:
      type: object
      properties:
        questionId:
          type: string
          minLength: 1
        value:
          type:
          - string
          - 'null'
      required:
      - questionId
      - value
    BasicAppetiteCaptureRequest:
      type: object
      description: 'Returns basic appetite result, form, and possible routes.


        Second serializer of the IDP appetite flow.


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


        Form contains:

        - basic appetite fields

        - enhanced appetite fields for risk profiles in appetite


        Possible routes contains possible route types for each requested combination of market and lob.


        ViewSet: BasicAppetiteCaptureViewSet


        Endpoint: /basic-appetite-capture/'
      properties:
        lobs:
          type: array
          items:
            type: string
        markets:
          type: array
          items:
            type: string
            format: uuid
        fieldValues:
          type: array
          items:
            $ref: '#/components/schemas/FieldValuesRequest'
      required:
      - fieldValues
      - lobs
      - markets
    basic_appetite_capture_invalid_body_request:
      type: object
      properties:
        lobs:
          type: array
          items: {}
          default:
          - Required or Invalid
        markets:
          type: array
          items: {}
          default:
          - Required or 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.