IVANS Utils API

The utils API from IVANS — 4 operation(s) for utils.

Operations 4

GET /api/v1/utils/enums/ Utils enums retrieve #
GET /api/v1/utils/form-field-types/ Utils form field types retrieve #
POST /api/v1/utils/suggest/configuration/ Utils suggest configuration create #
POST /api/v1/utils/suggest/ Utils suggest 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-utils-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-utils-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Identification Network Utils API
  version: 1.0.0
  description: IVANS Identification Network API
servers:
- url: https://distribution-staging.ivansinsurance.com
tags:
- name: Utils
paths:
  /api/v1/utils/enums/:
    get:
      operationId: utils_enums_retrieve
      description: Returns the label and value for all choice field values.
      tags:
      - Utils
      security:
      - oauth2:
        - read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enums'
          description: ''
        '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: Utils enums retrieve
      x-summary-source: derived
  /api/v1/utils/form-field-types/:
    get:
      operationId: utils_form_field_types_retrieve
      description: 'Returns information, including JSON data type, API route, and object properties, for all form field types.


        jsonDataType - the JSON data type of the answer that an integrator should submit for a field type. A list

        of JSON data types is provided if the answer can be one of multiple data types.


        optionsApiRoute - IDNET API route that an integrator should call to retrieve the options for a dropdown-like

        field


        optionPropertiesToDisplay - if the options retrieved via API are objects, this specifies which object

        properties an integrator should display on the front-end as answer choices


        optionPropertiesToSubmit - if the options retrieved via API are objects, this specifies which object

        properties an integrator should submit as the answer'
      tags:
      - Utils
      security:
      - oauth2:
        - read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fftypes'
          description: ''
        '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: Utils form field types retrieve
      x-summary-source: derived
  /api/v1/utils/suggest/configuration/:
    post:
      operationId: utils_suggest_configuration_create
      tags:
      - Utils
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestConfigurationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SuggestConfigurationRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SuggestConfigurationRequest'
        required: true
      security:
      - oauth2:
        - write
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Success:
                  value:
                    21e48f33-7a32-4678-bfde-249e488c736c:
                      suggestType: Coverage Bumping
                      suggestFormat: ^[\d,]+/[\d,]+/[\d,]+$
                      bumpingDirect: down
                    d9040681-ebd9-4c2f-bb13-76d52a5bada2:
                      suggestType: Synonym Search
                      suggestFormat: .+
                      bumpingDirect: null
                NoResultsFound:
                  value: '{}'
                  summary: No Results Found
          description: Valid request made for suggestion config
      summary: Utils suggest configuration create
      x-summary-source: derived
  /api/v1/utils/suggest/:
    post:
      operationId: utils_suggest_create
      description: 'Uses Marco Polo Synonym and Bumping services to suggest the best option for

        a given Attribute/RPA''s value list'
      tags:
      - Utils
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SuggestRequest'
            examples:
              SynonymExample:
                value:
                  value: house
                  guid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  quoteId: 3fa85f6457174562b3fc2c963f66afa6
                  mapFromGuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                summary: Synonym Example
                description: "\n        Find the best match for \"house\" out of \"home\", \"apartment\" and \"condo\"\n        "
              CoverageBumpingExample:
                value:
                  value: 1,000,000/1,500,000/1,000,000
                  guid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  quoteId: 3fa85f6457174562b3fc2c963f66afa6
                summary: Coverage Bumping Example
                description: "\n        Find the appropriate coverage amount\n        "
              RegularBumpingExample:
                value:
                  value: 7
                  guid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  quoteId: 3fa85f6457174562b3fc2c963f66afa6
                summary: Regular Bumping Example
                description: "\n        Find the appropriate amount\n        "
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/SuggestRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/SuggestRequest'
        required: true
      security:
      - oauth2:
        - write
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                SynonymSuccess:
                  value:
                  - label: Home
                    value: home
                    confidence: 1
                    synonym: home
                  - label: Home
                    value: home
                    confidence: 0.375
                    synonym: house
                  - label: Home
                    value: home
                    confidence: 0.2
                    synonym: menage
                  summary: Synonym Success
                  description: "\n                        • label - value list option label\n                        • value - value list option value\n                        • confidence - result of performing bi-gram fuzzy match\n                        • synonym - the synonym that was used to derive the confidence\n                        "
                CoverageBumpingSuccess:
                  value:
                  - label: 1,000,000/2,000,000/1,000,000
                    value: 102010
                    confidence: null
                    synonym: null
                  summary: Coverage Bumping Success
                  description: "\n                        • label - value list option label\n                        • value - value list option value\n                        • confidence - N/A\n                        • synonym - N/A\n                        "
                RegularBumpingSuccess:
                  value:
                  - label: 9 Months
                    value: 9
                    confidence: null
                    synonym: null
                  summary: Regular Bumping Success
                  description: "\n                        • label - value list option label\n                        • value - value list option value\n                        • confidence - N/A\n                        • synonym - N/A\n                        "
          description: Found a successful match
        '404':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Attribute/RPACouldNotBeFound:
                  value:
                    detail: Not found.
                  summary: Attribute/RPA could not be found
          description: Failed to find a valid match
      summary: Utils suggest create
      x-summary-source: derived
components:
  schemas:
    SuggestConfigurationRequest:
      type: object
      properties:
        guids:
          type: array
          items:
            type: string
            format: uuid
      required:
      - guids
    SuggestRequest:
      type: object
      properties:
        value:
          type: string
          minLength: 1
        guid:
          type: string
          format: uuid
        quoteId:
          type: string
          minLength: 1
        mapFromGuid:
          type: string
          format: uuid
      required:
      - guid
      - value
    enums:
      type: object
      properties:
        enumName:
          $ref: '#/components/schemas/enum_info'
      required:
      - enumName
    fftypes:
      type: object
      properties:
        fieldType:
          $ref: '#/components/schemas/field_type_info'
      required:
      - fieldType
    field_type_info:
      type: object
      properties:
        jsonDataType:
          type: string
          default: string
        optionsApiRoute:
          type: string
          default: string
        optionPropertiesToDisplay:
          type: array
          items: {}
          default:
          - string
        optionPropertiesToSubmit:
          type: array
          items: {}
          default:
          - string
        inputType:
          type: string
          default: string
    enum_info:
      type: object
      properties:
        value:
          type: integer
          default: 0
        label:
          type: string
          default: string
  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.