IVANS Claims Download API

The Claims Download API API from IVANS — 1 operation(s) for claims download api.

Operations 1

POST /ivans/api/carrier/claimsdownload Process request 3 #

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-claims-download-api-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-claims-download-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: IVANS Translation API's Claims Download API
  description: These API's expose endpoints to manage Download Transactions.
  license:
    name: Copyright (C) 2023 IVANS Insurance, All rights reserved
  version: '1.0'
servers:
- url: HTTPS://dev-cloud-dl.ivansinsurance.com
  description: Server URL in UAT environment
- url: HTTPS://cloud-dl.ivansinsurance.com
  description: Server URL in Production environment
tags:
- name: Claims Download API
paths:
  /ivans/api/carrier/claimsdownload:
    post:
      tags:
      - Claims Download API
      description: claims download operation
      operationId: processRequest_3
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      - name: transactionId
        in: header
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimsDownloadRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ClaimsDownloadResponse'
      summary: Process request 3
      x-summary-source: derived
components:
  schemas:
    AdjusterPartyInfo:
      type: object
      properties:
        assignedDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
        adjusterId:
          type: string
        communication:
          $ref: '#/components/schemas/Communication'
    ClaimsDownloadRequest:
      type: object
      properties:
        claimNumber:
          type: string
        producer:
          $ref: '#/components/schemas/ProducerType'
        carrierId:
          type: string
        claimsActivityCd:
          type: string
          enum:
          - CLI
          - ADJ
          - CLN
          - CLS
          - PMT
          - RES
        claimStatusCd:
          type: string
          enum:
          - O
          - C
          - R
          - S
          - OT
        claimsStatusDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
        claimReportedDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
        claimAddress:
          $ref: '#/components/schemas/AddressType'
        litigationStatusCd:
          type: string
          enum:
          - Active
          - Closed
        claimsPayment:
          type: array
          items:
            $ref: '#/components/schemas/PaymentInfo'
        reserveAdjustment:
          $ref: '#/components/schemas/ReserveAdjustment'
        lossDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
        incidentDescription:
          type: string
        policy:
          $ref: '#/components/schemas/PolicyInfo'
        insured:
          $ref: '#/components/schemas/GeneralPartyInfoType'
        adjusterParties:
          type: array
          items:
            $ref: '#/components/schemas/AdjusterParty'
        claimantParties:
          type: array
          items:
            $ref: '#/components/schemas/ClaimsParty'
        transactionDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
        notes:
          type: string
        claimstype:
          type: string
        losscausecd:
          type: string
        lossnotices:
          type: array
          items:
            $ref: '#/components/schemas/LossnoticeType'
    ContactType:
      type: object
      properties:
        contacttypecd:
          type: string
          enum:
          - Billing Contact
          - Audit Contact
          - Claim Contact
          - Risk Manager
          - Executive Contact
          - Misc. Contact
          - Customer Service Rep
        personalname:
          $ref: '#/components/schemas/PersonalnameType'
        email:
          type: string
        phone:
          $ref: '#/components/schemas/PhoneType'
        employedbyinsuredind:
          type: boolean
    PaymentInfo:
      type: object
      properties:
        paymentTypeCd:
          type: string
          enum:
          - AdjExp
          - Adjustment
          - Counter
          - Final
          - Payment
          - Recovery
          - SRecov
          - StopPay
          - Transfer
          - Void
        totalPaymentAmount:
          type: number
        totalclaimlosspaidamt:
          type: number
        checkNumber:
          type: string
        paymentDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
        paymentDesc:
          type: string
        claimsPartyReferenceIdentifier:
          type: string
        losscausecd:
          type: string
        payee:
          $ref: '#/components/schemas/GeneralPartyInfoType'
        lumpsumind:
          type: boolean
    CoverageselfinsuredretentionType:
      type: object
      properties:
        selfinsuredretentiontypecd:
          type: string
        selfinsuredretentionamt:
          type: number
        retentionappliestocd:
          type: string
    ReserveAdjustment:
      type: object
      properties:
        reserveAdjustmentAmount:
          type: number
        reserveAdjustmentDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
    WorklossnoticeType:
      type: object
      properties:
        jurisdictioncd:
          type: string
        jurisdictiondesc:
          type: string
        wccclaimtypecd:
          type: string
        secondaryinjuryfundind:
          type: boolean
        otherinsuranceind:
          type: boolean
        fraudulentclaimcd:
          type: string
        employeeinfo:
          type: array
          items:
            type: object
          properties:
            empty:
              type: boolean
        coverages:
          type: array
          items:
            type: object
          properties:
            empty:
              type: boolean
        vesselcallid:
          type: string
        losscondition:
          type: array
          items:
            type: object
          properties:
            empty:
              type: boolean
    AutolossnoticeType:
      type: object
      properties:
        vehiclesinvolved:
          type: array
          items:
            type: object
          properties:
            empty:
              type: boolean
        coverages:
          type: array
          items:
            type: object
          properties:
            empty:
              type: boolean
    ClaimsinjuryType:
      type: object
      properties:
        bodypartcd:
          type: string
        injurynaturecd:
          type: string
        losscausecd:
          type: string
    ClaimsParty:
      type: object
      properties:
        generalPartyInfo:
          $ref: '#/components/schemas/GeneralPartyInfoType'
        claimsPartyInfo:
          $ref: '#/components/schemas/ClaimantInfo'
        claimsinjury:
          $ref: '#/components/schemas/ClaimsinjuryType'
    ProducerType:
      type: object
      properties:
        organizationname:
          type: string
          readOnly: true
        name:
          $ref: '#/components/schemas/PersonalnameType'
          readOnly: true
        address:
          $ref: '#/components/schemas/AddressType'
          readOnly: true
        npn:
          type: string
          readOnly: true
        contractcode:
          type: string
        contractsubcode:
          type: string
          readOnly: true
        contact:
          $ref: '#/components/schemas/ContactType'
          readOnly: true
    Communication:
      type: object
      properties:
        phone:
          type: array
          items:
            $ref: '#/components/schemas/PhoneType'
        email:
          type: string
    PolicyInfo:
      type: object
      properties:
        policyNumber:
          type: string
        broadLOBCd:
          type: string
          enum:
          - P
          - C
          - B
          - F
          - S
        lobCd:
          type: string
          enum:
          - ACCT
          - AGENT
          - AGLIA
          - AGPP
          - AGPR
          - APKGE
          - ARCH
          - AUTOB
          - AUTOP
          - BANDM
          - BOAT
          - BOP
          - BOPGL
          - BOPPR
          - CFIRE
          - CGL
          - CPKGE
          - CRIM
          - UMBRC
          - CYBER
          - DFIRE
          - DNTL
          - DO
          - EL
          - EO
          - EPLI
          - EQ
          - EQLIA
          - EXLIA
          - FIDUC
          - FLOOD
          - GARAG
          - HLTH
          - HOME
          - INMRC
          - INMRP
          - KIDRA
          - LAW
          - LIFE
          - LL
          - LMORT
          - MEDIA
          - MHOME
          - MMAL
          - MPL
          - MTRCR
          - OCMRC
          - PHYS
          - PL
          - PLMSC
          - PPKGE
          - PPL
          - PROP
          - PRSL
          - UMBRP
          - RECV
          - RRPRL
          - SFRNC
          - SMP
          - SURE
          - WIND
          - WORK
          - WORKV
          - YACHT
        naicCd:
          type: string
        effectiveDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
        expirationDt:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
    PhoneType:
      type: object
      properties:
        phonetype:
          type: string
          enum:
          - business
          - personal
          - cell
        phone:
          type: string
        extension:
          type: string
    LiabilitylossnoticeType:
      type: object
      properties:
        locationnum:
          type: string
        buildingnum:
          type: string
        subjectofinsurancecd:
          type: string
        insuredinterestcd:
          type: string
        itemdesc:
          type: string
        objectlossdesc:
          type: string
        whereseendesc:
          type: string
        operationsdesc:
          type: string
        otherexposuredesc:
          type: string
        coverages:
          type: array
          items:
            type: object
          properties:
            empty:
              type: boolean
    ClaimantInfo:
      type: object
      properties:
        claimsPartyRoleCd:
          type: string
          enum:
          - PAYEE
          - CLM
          - DRV
          - ReptBy
        claimsPartyReferenceNumber:
          type: string
        reportedDate:
          format: yyyy-MM-dd
          $ref: '#/components/schemas/LocalDate'
          example: '2025-01-01'
        involvementdesc:
          type: string
    PersonalnameType:
      type: object
      properties:
        firstname:
          type: string
          readOnly: true
        middleintialname:
          type: string
          readOnly: true
        lastname:
          type: string
          readOnly: true
        fullname:
          type: string
    Era:
      type: object
      properties:
        value:
          type: integer
          format: int32
    GeneralPartyInfoType:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/PersonalnameType'
        commercialname:
          type: string
        address:
          $ref: '#/components/schemas/AddressType'
        communication:
          $ref: '#/components/schemas/Communication'
    AddressType:
      type: object
      properties:
        addrtypecd:
          type: string
          enum:
          - Billing Address
          - Branch Office
          - Contributing Address
          - Data Backup Storage Address
          - Duplicate Records Address
          - Furthest Terminal Address
          - Garaging Address
          - Harbor
          - Insured's Address
          - Job Site
          - Leader Address
          - Leased Building Address
          - Legal Address
          - The address at which the loss occurred.
          - Mailing Address
          - Manufacturing Address
          - Marina
          - Military Base Address
          - Owned Building Address
          - Physical Risk Address/Location
          - Point Of Departure Address
          - Point Of Destination Address
          - Port
          - Previous Address
          - Private Dock
          - Public Dock
          - Payroll Office
          - Quay
          - Recipient Address
          - Rented Building Address
          - Rented To Others
          - The claim location under which the claim is being settled.
          - Shipping Address
          - Software Backup Storage Address
          - Storage
          - Street Address
          - Terminal
          - Wharf
        addr1:
          type: string
        addr2:
          type: string
        city:
          type: string
        stateprovcd:
          type: string
          enum:
          - AL
          - AK
          - AZ
          - AR
          - CA
          - CO
          - CT
          - DC
          - DE
          - FL
          - GA
          - HI
          - ID
          - IL
          - IN
          - IA
          - KS
          - KY
          - LA
          - ME
          - MD
          - MA
          - MI
          - MN
          - MS
          - MO
          - MT
          - NE
          - NV
          - NH
          - NJ
          - NM
          - NY
          - NC
          - ND
          - OH
          - OK
          - OR
          - PA
          - PR
          - RI
          - SC
          - SD
          - TN
          - TX
          - UT
          - VT
          - VA
          - WA
          - WV
          - WI
          - WY
          - AB
          - BC
          - MB
          - NB
          - NL
          - NS
          - 'ON'
          - PE
          - QC
          - SK
          - NT
          - NU
          - YT
          - AGU
          - BCN
          - BCS
          - CAM
          - CHH
          - CHP
          - CMX
          - COA
          - COL
          - DUR
          - GRO
          - GUA
          - HID
          - JAL
          - MEX
          - MIC
          - MOR
          - NAY
          - NLE
          - OAX
          - PUE
          - QUE
          - ROO
          - SIN
          - SLP
          - SON
          - TAB
          - TAM
          - TLA
          - VER
          - YUC
          - ZAC
          - AS
          - FM
          - GU
          - MH
          - MP
          - PW
          - VI
        postalcd:
          type: string
        county:
          type: string
        country:
          type: string
        latitude:
          type: string
        longitude:
          type: string
    LossnoticeType:
      type: object
      properties:
        autoloss:
          $ref: '#/components/schemas/AutolossnoticeType'
        liabilityloss:
          $ref: '#/components/schemas/LiabilitylossnoticeType'
        propertyloss:
          $ref: '#/components/schemas/PropertylossnoticeType'
        workloss:
          $ref: '#/components/schemas/WorklossnoticeType'
    AdjusterParty:
      type: object
      properties:
        generalPartyInfo:
          $ref: '#/components/schemas/GeneralPartyInfoType'
        adjusterPartyInfo:
          $ref: '#/components/schemas/AdjusterPartyInfo'
    PropertylossnoticeType:
      type: object
      properties:
        claimproperty:
          type: array
          items:
            type: object
          properties:
            empty:
              type: boolean
        realestatetypecd:
          type: string
        realestateypedesc:
          type: string
        subjectofinsurancecd:
          type: string
        losskindcd:
          type: string
        objectlossdesc:
          type: string
        damagedesc:
          type: string
        otherinsuranceind:
          type: boolean
        mortgageeind:
          type: boolean
        occupancytypecd:
          type: string
        coverageselfinsuredretention:
          $ref: '#/components/schemas/CoverageselfinsuredretentionType'
        coverages:
          type: array
          items:
            type: object
          properties:
            empty:
              type: boolean
    LocalDate:
      type: object
      properties:
        year:
          type: integer
          format: int32
        month:
          type: string
          enum:
          - JANUARY
          - FEBRUARY
          - MARCH
          - APRIL
          - MAY
          - JUNE
          - JULY
          - AUGUST
          - SEPTEMBER
          - OCTOBER
          - NOVEMBER
          - DECEMBER
        monthValue:
          type: integer
          format: int32
        dayOfMonth:
          type: integer
          format: int32
        chronology:
          $ref: '#/components/schemas/IsoChronology'
        dayOfWeek:
          type: string
          enum:
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          - SATURDAY
          - SUNDAY
        leapYear:
          type: boolean
        dayOfYear:
          type: integer
          format: int32
        era:
          $ref: '#/components/schemas/Era'
    ClaimsDownloadResponse:
      type: object
      properties:
        transactionId:
          type: string
          description: Unique id for this transaction
        code:
          type: string
          enum:
          - SUCCESS
          - FAILURE
          example: SUCCESS
        mailbox:
          type: string
        message:
          type: string
    IsoChronology:
      type: object
      properties:
        id:
          type: string
        calendarType:
          type: string
x-provenance:
  method: searched
  source: https://api.ivans.com/reference/getdocumentmetainfo
  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.