IVANS Classification Codes API

openapi: 3.2.0
info:
  title: Identification Network Classification Codes API
  version: 1.0.0
  description: IVANS Identification Network API
servers:
- url: https://distribution-staging.ivansinsurance.com
tags:
- name: classification-codes
paths:
  /api/v1/classification-codes/:
    post:
      operationId: classification_codes_create
      description: 'Returns corresponding classification codes for a given classification standard, based on

        an optional NAICS index, state, and/or search term.


        Note: A maximum of 100 class codes can be returned based on provided search and filters'
      parameters:
      - in: query
        name: page
        schema:
          type: integer
        description: A page number within the paginated result set.
      - in: query
        name: page_size
        schema:
          type: integer
        description: Number of results to return per page.
      tags:
      - classification-codes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClassificationCodeSearchRequest'
            examples:
              StandardExample:
                value:
                  classificationStandard: 759e39fd-26e8-4be4-bfa5-e0b4fb73ead2
                  filterFieldValues:
                  - questionId: f23c0847-1fce-4627-8744-b69bfdfa7b47
                    value: 24a5298c-9747-442b-8b3d-58587ee5fc08
                  - questionId: 3dcdd8fa-60f0-4352-b464-d444d91aa947
                    value: IL
                  search: '109'
                summary: Standard example
                description: The most common scenario is to send a request with classificationStandard, filterFieldValues, and search. The key "classificationStandard" accepts a UUID of a classification standard record. The key "filterFieldValues" is a list of dictionaries, in which questionId is the UUID of a form field and value is the answer to the field. These fields should correspond to either NAICS index or state fields, and will be used to filter the matching classification codes. The key "search" is a string that can be used to match the code or description of the codes.
              EmptyFilterFieldValues:
                value:
                  classificationStandard: 759e39fd-26e8-4be4-bfa5-e0b4fb73ead2
                  filterFieldValues: []
                  search: '109'
                summary: Empty filterFieldValues
                description: If "filterFieldValues" is empty, the resulting classification codes will not be filtered by NAICS or state.
              ExcludeSearch:
                value:
                  classificationStandard: 759e39fd-26e8-4be4-bfa5-e0b4fb73ead2
                  filterFieldValues:
                  - questionId: f23c0847-1fce-4627-8744-b69bfdfa7b47
                    value: 24a5298c-9747-442b-8b3d-58587ee5fc08
                  - questionId: 3dcdd8fa-60f0-4352-b464-d444d91aa947
                    value: IL
                summary: Exclude search
                description: If the "search" term is excluded from the request, the resulting classification codes will not be matched by code or description.
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ClassificationCodeSearchRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ClassificationCodeSearchRequest'
        required: true
      security:
      - oauth2:
        - write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedClassificationCodeDetailList'
          description: Successfully requested the classification codes.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/classification_code_invalid_request_body'
          description: Invalid body request, possible error reasons 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: Classification codes create
      x-summary-source: derived
  /api/v1/classification-codes/{uuid}/:
    get:
      operationId: classification_codes_retrieve
      description: Returns an individual class code based on the UUID.
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - classification-codes
      security:
      - oauth2:
        - read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedClassificationCodeDetailWithRelatedList'
          description: Successfully requested the classification code.
        '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.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/classification_code_retrieve_responses'
          description: UUID is not valid or does not have corresponding classification code.
      summary: Classification codes retrieve
      x-summary-source: derived
components:
  schemas:
    RelatedCode:
      type: object
      properties:
        code:
          type: string
        description:
          type: string
        uuid:
          type: string
      required:
      - code
      - description
      - uuid
    ClassificationCodeDetail:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
        persistentId:
          type: string
          readOnly: true
          description: A hash of the code and description.Used to match the same code across different versions of the same Classification Standard.
        code:
          type: string
          maxLength: 10
        description:
          type: string
        states:
          type: array
          items:
            $ref: '#/components/schemas/SubdivisionSimple'
        standard:
          $ref: '#/components/schemas/Standard'
      required:
      - code
      - description
      - persistentId
      - standard
      - states
      - uuid
    SubdivisionSimple:
      type: object
      properties:
        alpha2:
          type:
          - string
          - 'null'
          maxLength: 2
        uuid:
          type: string
          format: uuid
          readOnly: true
      required:
      - uuid
    FieldValuesRequest:
      type: object
      properties:
        questionId:
          type: string
          minLength: 1
        value:
          type:
          - string
          - 'null'
      required:
      - questionId
      - value
    PaginatedClassificationCodeDetailList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: https://distribution.ivansinsurance.com/api/v1/classification-codes/?page=3
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: https://distribution.ivansinsurance.com/api/v1/classification-codes/?page=1
        results:
          type: array
          items:
            $ref: '#/components/schemas/ClassificationCodeDetail'
    Standard:
      type: object
      properties:
        name:
          type: string
          maxLength: 128
        externalId:
          type: string
          maxLength: 255
        market:
          type:
          - string
          - 'null'
        marketName:
          type:
          - string
          - 'null'
        lineOfBusiness:
          type:
          - string
          - 'null'
        lineOfBusinessCode:
          type:
          - string
          - 'null'
      required:
      - externalId
      - lineOfBusiness
      - lineOfBusinessCode
      - market
      - marketName
      - name
    classification_code_retrieve_responses:
      type: object
      properties:
        details:
          type: string
          default: Not found.
    ClassificationCodeSearchRequest:
      type: object
      description: 'Returns a filtered list of classification codes.


        Filters:

        - ClassificationStandard

        - values to previously answered RPAs for NAICS, State, and ClassificationCode

        - search value used to match the code or description of the codes'
      properties:
        classificationStandard:
          type: string
          format: uuid
        filterFieldValues:
          type: array
          items:
            $ref: '#/components/schemas/FieldValuesRequest'
        search:
          type: string
      required:
      - classificationStandard
      - filterFieldValues
    PaginatedClassificationCodeDetailWithRelatedList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: https://distribution.ivansinsurance.com/api/v1/classification-codes/{uuid}/?page=3
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: https://distribution.ivansinsurance.com/api/v1/classification-codes/{uuid}/?page=1
        results:
          type: array
          items:
            $ref: '#/components/schemas/ClassificationCodeDetailWithRelated'
    classification_code_invalid_request_body:
      type: object
      properties:
        classificationStandard:
          type: string
          default: Required or Invalid
        filterFieldValues:
          type: array
          items: {}
          default:
          - Required or Invalid
    ClassificationCodeDetailWithRelated:
      type: object
      description: 'Adds related codes to ClassificationCodeDetailSerializer.


        ViewSet: ClassificationCodeViewSet


        Endpoint: /classification-codes/{uuid}/'
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
        persistentId:
          type: string
          readOnly: true
          description: A hash of the code and description.Used to match the same code across different versions of the same Classification Standard.
        code:
          type: string
          maxLength: 10
        description:
          type: string
        states:
          type: array
          items:
            $ref: '#/components/schemas/SubdivisionSimple'
        standard:
          $ref: '#/components/schemas/Standard'
        relatedCodes:
          type: array
          items:
            $ref: '#/components/schemas/RelatedCode'
      required:
      - code
      - description
      - persistentId
      - relatedCodes
      - standard
      - states
      - uuid
  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.