openapi: 3.2.0
info:
  contact:
    email: support@dealerware.com
    name: Dealerware Support
    url: https://support.dealerware.com
  description: MOB-API
  termsOfService: support@dealerware.com
  title: MOB Insurance API
  version: 1.0.0
servers:
- url: https://api.dealerware.com
  description: Production server
- url: https://api.dw-tst.com
  description: Staging server
security:
- Auth0: []
tags:
- name: Insurance
paths:
  /admin/customers/{customer_id}/insurance:
    parameters:
    - name: api-version
      in: header
      description: Target API version
      required: true
      schema:
        type: integer
        example: 4
    get:
      summary: Return the current active insurance the customer has
      operationId: getAdminCustomerInsurance
      tags:
      - Insurance
      parameters:
      - name: customer_id
        in: path
        description: The id of the customer
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminCustomerInsuranceResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '406':
          $ref: '#/components/responses/NotAcceptable'
    post:
      summary: Create a insurance for a customer
      operationId: postAdminCustomerInsurance
      tags:
      - Insurance
      parameters:
      - name: customer_id
        in: path
        required: true
        description: the customer ID
        schema:
          type: integer
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - expires_on
              properties:
                carrier:
                  type: string
                  example: UnitedHealthCare
                policy_number:
                  type: string
                  example: GAC56232
                expires_on:
                  type: string
                  example: '2023-02-13T16:08:34Z'
                image:
                  type: string
                  format: binary
      responses:
        '201':
          $ref: '#/components/responses/Created'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
    put:
      summary: Update insurance for a customer
      operationId: updateAdminCustomerInsurance
      tags:
      - Insurance
      parameters:
      - name: customer_id
        in: path
        required: true
        description: the customer ID
        schema:
          type: integer
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - expires_on
              properties:
                carrier:
                  type: string
                  example: UnitedHealthCare
                policy_number:
                  type: string
                  example: GAC56232
                expires_on:
                  type: string
                  example: '2023-02-13T16:08:34Z'
                image:
                  type: string
                  format: binary
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
components:
  responses:
    NoContent:
      description: No Content
    UnsupportedMediaType:
      description: Unsupported Media Type
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Accepted media types is limited to JSON (application/json)
              code:
                type: integer
                example: 6789
    Created:
      description: Created
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: The request has been fulfilled and has resulted in a new resource being created
    UnprocessableEntity:
      description: Unprocessable Content
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Invalid resource id
              code:
                type: integer
                example: 6789
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Resource with id :id not found
              code:
                type: integer
                example: 6789
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Invalid authorization token
              code:
                type: integer
                example: 6789
    NotAcceptable:
      description: Not Acceptable
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Missing headers in request
              code:
                type: integer
                example: 6789
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                example: Request is forbidden
              code:
                type: integer
                example: 6789
  schemas:
    InsuranceSufficiencyRentalProperties:
      type:
      - object
      - 'null'
      properties:
        sufficient:
          type: boolean
          example: true
          description: Represents if the insurance document is sufficient
        status:
          type: string
          example: pass
          description: Status of the insurance document sufficiency
        valid_until:
          type: string
          example: '2024-12-31T23:59:59Z'
          description: Timestamp of when the insurance document sufficiency is valid until
        checked_at:
          type: string
          example: '2024-01-01T12:00:00Z'
          description: Timestamp of when the insurance document sufficiency was last checked
        details:
          type: object
          description: Additional details about the insurance document sufficiency provided by 3rd party
          properties:
            comprehensive_coverage_meets_requirements:
              type: string
              example: fail
            expiration_date_comparison:
              type: string
              example: pass
            insureds_match:
              type: string
              example: unknown
            rental_covered_for_collision:
              type: string
              example: pass
            required_policy_information_is_present:
              type: string
              example: pass
    InsuranceSufficiencyLoanerProperties:
      type:
      - object
      - 'null'
      properties:
        sufficient:
          type: boolean
          example: true
          description: Represents if the insurance document is sufficient
        status:
          type: string
          example: pass
          description: Status of the insurance document sufficiency
        valid_until:
          type: string
          example: '2024-12-31T23:59:59Z'
          description: Timestamp of when the insurance document sufficiency is valid until
        checked_at:
          type: string
          example: '2024-01-01T12:00:00Z'
          description: Timestamp of when the insurance document sufficiency was last checked
        details:
          type: object
          description: Additional details about the insurance document sufficiency provided by 3rd party
          properties:
            collision_coverage_meets_requirements:
              type: string
              example: pass
            comprehensive_coverage_meets_requirements:
              type: string
              example: fail
            expiration_date_comparison:
              type: string
              example: pass
            insureds_match:
              type: string
              example: unknown
            required_policy_information_is_present:
              type: string
              example: pass
    AdminCustomerInsuranceResponse:
      type: object
      properties:
        id:
          type: integer
          example: 12
        carrier:
          type:
          - string
          - 'null'
          example: UnitedHealthCare
        policy_number:
          type:
          - string
          - 'null'
          example: GAC56232
        expires_on:
          type: string
          example: '2023-02-13T16:08:34Z'
        customer_id:
          type: integer
          example: 110
        is_stale:
          type: boolean
          example: false
          description: Represents if the insurance account has not been refreshed since a time period determined by business rules
        is_verified:
          type: boolean
          example: false
          description: Represents if the insurance account is verified according to business rules
        is_incomplete:
          type: boolean
          example: false
          description: Indicates if the insurance record is missing required fields (carrier, policy_number, or expires_on)
        missing_required_fields:
          type: array
          items:
            type: string
            enum:
            - carrier
            - policy_number
            - expires_on
          example: []
          description: List of required fields that are missing from the insurance record
        refreshed_at:
          type:
          - string
          - 'null'
          example: '2023-02-13T16:08:34Z'
          description: Timestamp of when the last time the account was verified by the third party.
        insurance_verification_method:
          type:
          - string
          - 'null'
          example: manual
          description: 'Axle Ignition completion type for how insurance data was obtained (for example link, manual, proxy, or basic).

            '
        insurance_verification_detail:
          type:
          - string
          - 'null'
          example: document-ai-declarations-page
          description: 'Axle Ignition completion detail identifying the specific process used (for example user-portal-login, document-ai-declarations-page, or document-ai-id-card).

            '
        image:
          type:
          - object
          - 'null'
          properties:
            id:
              type: integer
              example: 323
            url:
              type: string
              example: https://example.com/image_url.png
        sufficiency:
          type:
          - object
          - 'null'
          properties:
            loaner:
              $ref: '#/components/schemas/InsuranceSufficiencyLoanerProperties'
            rental:
              $ref: '#/components/schemas/InsuranceSufficiencyRentalProperties'
  securitySchemes:
    Auth0:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://dealerware.auth0.com/oauth/token
          scopes: {}
x-provenance:
  method: searched
  source: https://developer.dealerware.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.dealerware.com/reference/admincustomerget-1.md
  - https://developer.dealerware.com/reference/createblacklist-1.md
  - https://developer.dealerware.com/reference/deleteadmincontractcancel-1.md
  - https://developer.dealerware.com/reference/deleteadmincontractsplitbill-1.md
  - https://developer.dealerware.com/reference/deleteadmincontractsplitbillpayment-1.md
  - https://developer.dealerware.com/reference/deleteadmincontractswarranty-1.md
  - https://developer.dealerware.com/reference/deleteadmindealershipwebhook.md
  - https://developer.dealerware.com/reference/deleteadmindriver-1.md
  - https://developer.dealerware.com/reference/deletecontractnote-1.md
  - https://developer.dealerware.com/reference/deletecustomerfromblacklist-1.md
  - https://developer.dealerware.com/reference/deletedealershipcustomernotes.md
  - https://developer.dealerware.com/reference/deletedealershipcustomers-1.md
  - https://developer.dealerware.com/reference/deleteemployeeactivation-1.md
  - https://developer.dealerware.com/reference/deletefleet-1.md
  - https://developer.dealerware.com/reference/deleteissue-1.md
  - https://developer.dealerware.com/reference/getadmincontractadjustments-1.md
  - https://developer.dealerware.com/reference/getadmincontractauthorization-1.md
  - https://developer.dealerware.com/reference/getadmincontractcustomer-1.md
  - https://developer.dealerware.com/reference/getadmincontractpayments-1.md
  - https://developer.dealerware.com/reference/getadmincontractpricing-1.md
  - https://developer.dealerware.com/reference/getadmincontractsdrivers-1.md
  - https://developer.dealerware.com/reference/getadmincontractsplitbill-1.md
  - https://developer.dealerware.com/reference/getadmincontractsplitbilladjustment-1.md
  - https://developer.dealerware.com/reference/getadmincontractstoggles-1.md
  - https://developer.dealerware.com/reference/getadmincontractvehiclesavailable-1.md
  - https://developer.dealerware.com/reference/getadmincontractvehiclesavailablesearch-1.md
  - https://developer.dealerware.com/reference/getadmincustomercreditcards-1.md
  - https://developer.dealerware.com/reference/getadmincustomeremployer-1.md
  - https://developer.dealerware.com/reference/getadmincustomerinsurance-1.md
  - https://developer.dealerware.com/reference/getadmincustomernotificationsfailed.md
  - https://developer.dealerware.com/reference/getadmincustomerscontracts-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcontracts-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcontractsmanifesttoday-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcontractssearch-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomernotes.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomers-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomersmessagesprofiles-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomersremoteprofilesearch-1.md
  - https://developer.dealerware.com/reference/getadmindealershipcustomerssearch-1.md
  - https://developer.dealerware.com/reference/getadmindealershipemployees-1.md
  - https://developer.dealerware.com/reference/getadmindealershipemployeessearch-1.md
  - https://developer.dealerware.com/reference/getadmindealershipfleetscontractsandvehicles-1.md
  - https://developer.dealerware.com/reference/getadmindealershipserviceadvisors-1.md
  - https://developer.dealerware.com/reference/getadmindealershipwebhook.md
  - https://developer.dealerware.com/reference/getadmindealershipwebhooks.md
  - https://developer.dealerware.com/reference/getadmindriver-1.md
  - https://developer.dealerware.com/reference/getcontract-1.md
  - https://developer.dealerware.com/reference/getcontractnotes-1.md
  - https://developer.dealerware.com/reference/getcontractscontactless-1.md
  - https://developer.dealerware.com/reference/getcontractscontactlessdriver-1.md
  - https://developer.dealerware.com/reference/getcontractssaleslead.md
  - https://developer.dealerware.com/reference/getcontractwarranty-1.md
  - https://developer.dealerware.com/reference/getdealership-1.md
  - https://developer.dealerware.com/reference/getdealershipaddress-1.md
  - https://developer.dealerware.com/reference/getdealershipavailability-1.md
  - https://developer.dealerware.com/reference/getdealershipavailabilityintervals-1.md
  - https://developer.dealerware.com/reference/getdealershipavailabilityintervalscontinuous-1.md
  - https://developer.dealerware.com/reference/getdealershipavailabilityintervalscontinuousdaily-1.md
  - https://developer.dealerware.com/reference/getdealershipavailabilityintervalsdaily-1.md
  - https://developer.dealerware.com/reference/getdealershipcalendarbookingchannels.md
  - https://developer.dealerware.com/reference/getdealershipcalendarcontracts-1.md
  - https://developer.dealerware.com/reference/getdealershipcalendarvehicles-1.md
  - https://developer.dealerware.com/reference/getdealershipcontractavailablevehicles.md
  - https://developer.dealerware.com/reference/getdealershipemployeeroles-1.md
  - https://developer.dealerware.com/reference/getdealershipfleetpricing-1.md
  - https://developer.dealerware.com/reference/getdealershipfleets-1.md
  - https://developer.dealerware.com/reference/getdealershipkpis-1.md
  - https://developer.dealerware.com/reference/getdealershipmakesandmodels-1.md
  - https://developer.dealerware.com/reference/getdealershipreportreceivables-1.md
  - https://developer.dealerware.com/reference/getdealershipreportrevenue-1.md
  - https://developer.dealerware.com/reference/getdealershipreportrevenuesummary-1.md
  - https://developer.dealerware.com/reference/getdealershipreporttransactions-1.md
  - https://developer.dealerware.com/reference/getdealershipreporttransactionsfilteredsorted-1.md
  - https://developer.dealerware.com/reference/getdealershiproles-1.md
  - https://developer.dealerware.com/reference/getdealerships-1.md
  - https://developer.dealerware.com/reference/getdealershipsearch-1.md
  - https://developer.dealerware.com/reference/getdealershipsettings-1.md
  - https://developer.dealerware.com/reference/getdealershiptelematicssettings-1.md
  - https://developer.dealerware.com/reference/getdealershiptrimtypesinfleets-1.md
  - https://developer.dealerware.com/reference/getdealershipvehicles-1.md
  - https://developer.dealerware.com/reference/getdealershipvehiclessearch-1.md
  - https://developer.dealerware.com/reference/getdocument-1.md
  - https://developer.dealerware.com/reference/getemployee-1.md
  - https://developer.dealerware.com/reference/getfleet-1.md
  - https://developer.dealerware.com/reference/getfleetavailability-1.md
  - https://developer.dealerware.com/reference/getfleetavailabilityintervals-1.md
  - https://developer.dealerware.com/reference/getfleetavailabilityintervalscontinuous-1.md
  - https://developer.dealerware.com/reference/getfleetavailabilityintervalscontinuousdaily-1.md
  - https://developer.dealerware.com/reference/getfleetavailabilityintervalsdaily-1.md
  - https://developer.dealerware.com/reference/getfleetsettings-1.md
  - https://developer.dealerware.com/reference/getgeolocationradialdistance-1.md
  - https://developer.dealerware.com/reference/getmappablefields-1.md
  - https://developer.dealerware.com/reference/getprogramavailability-1.md
  - https://developer.dealerware.com/reference/getprogramavailabilityintervals-1.md
  - https://developer.dealerware.com/reference/getrentalagreementpdf-1.md
  - https://developer.dealerware.com/reference/getreservationcustomer-1.md
  - https://developer.dealerware.com/reference/getshortremoteprofile.md
  - https://developer.dealerware.com/reference/getuser-1.md
  - https://developer.dealerware.com/reference/getuserdealershiproles-1.md
  - https://developer.dealerware.com/reference/getuserpreferences.md
  - https://developer.dealerware.com/reference/getvehicle-1.md
  - https://developer.dealerware.com/reference/getvehicleevents-1.md
  - https://developer.dealerware.com/reference/getvehiclegroupdefleetsettings.md
  - https://developer.dealerware.com/reference/getvehicleissues-1.md
  - https://developer.dealerware.com/reference/getvehicletelemetry-1.md
  - https://developer.dealerware.com/reference/patchadminvehicle.md
  - https://developer.dealerware.com/reference/patchdealershipandfleetsettings-1.md
  - https://developer.dealerware.com/reference/postadmincontractbillingadjustment-1.md
  - https://developer.dealerware.com/reference/postadmincontractreceiptpdf-1.md
  - https://developer.dealerware.com/reference/postadmincontractsdrivers-1.md
  - https://developer.dealerware.com/reference/postadmincontractsettlement-1.md
  - https://developer.dealerware.com/reference/postadmincontractsplitbill-1.md
  - https://developer.dealerware.com/reference/postadmincontractsplitbilladjustment-1.md
  - https://developer.dealerware.com/reference/postadmincontractsplitbillpayment-1.md
  - https://developer.dealerware.com/reference/postadmincontractsplitbillpdf-1.md
  - https://developer.dealerware.com/reference/postadmincustomeremployer-1.md
  - https://developer.dealerware.com/reference/postadmincustomerinsurance-1.md
  - https://developer.dealerware.com/reference/postadmincustomernotificationreplay.md
  - https://developer.dealerware.com/reference/postadmindealershipcustomer-1.md
  - https://developer.dealerware.com/reference/postadmindealershipcustomermessage-1.md
  - https://developer.dealerware.com/reference/postadmindealershipcustomernote.md
  - https://developer.dealerware.com/reference/postadmindealershipcustomersremoteprofileqrcode.md
  - https://developer.dealerware.com/reference/postadmindealershipemployee-1.md
  - https://developer.dealerware.com/reference/postadmindealershipwebhook.md
  - https://developer.dealerware.com/reference/postcontactlessdriversignature-1.md
  - https://developer.dealerware.com/reference/postcontractcontactlessmessages-1.md
  - https://developer.dealerware.com/reference/postcontractnote-1.md
  - https://developer.dealerware.com/reference/postcontractscontactlesssignatures-1.md
  - https://developer.dealerware.com/reference/postcontractssaleslead.md
  - https://developer.dealerware.com/reference/postcontractswarranty-1.md
  - https://developer.dealerware.com/reference/postdealeronboardingvehicles-1.md
  - https://developer.dealerware.com/reference/postdealershipfleets-1.md
  - https://developer.dealerware.com/reference/postdealershipvehicle-1.md
  - https://developer.dealerware.com/reference/postdealervehiclescheckingonboardingstatus-1.md
  - https://developer.dealerware.com/reference/postdriversignature-1.md
  - https://developer.dealerware.com/reference/postemployeeactivation-1.md
  - https://developer.dealerware.com/reference/postfleetcontract-1.md
  - https://developer.dealerware.com/reference/postfleetvehicles-1.md
  - https://developer.dealerware.com/reference/postlogin-1.md
  - https://developer.dealerware.com/reference/postreportingdata.md
  - https://developer.dealerware.com/reference/postreportingmetadata.md
  - https://developer.dealerware.com/reference/postuserconfirmations-1.md
  - https://developer.dealerware.com/reference/postuserpasswordforgot-1.md
  - https://developer.dealerware.com/reference/postvehicleissue-1.md
  - https://developer.dealerware.com/reference/putadmincontractfinish-1.md
  - https://developer.dealerware.com/reference/putadmincontractpaymentmethod-1.md
  - https://developer.dealerware.com/reference/putadmincontractsplitbill-1.md
  - https://developer.dealerware.com/reference/putadmincontractstart-1.md
  - https://developer.dealerware.com/reference/putadmincontractswarranty-1.md
  - https://developer.dealerware.com/reference/putadmincontractunassignvehicle-1.md
  - https://developer.dealerware.com/reference/putadmincontractvehicle-1.md
  - https://developer.dealerware.com/reference/putadmincustomeremployer-1.md
  - https://developer.dealerware.com/reference/putadmincustomerupdate-1.md
  - https://developer.dealerware.com/reference/putadmindealershipwebhook.md
  - https://developer.dealerware.com/reference/putadmindriver-1.md
  - https://developer.dealerware.com/reference/putcontract-1.md
  - https://developer.dealerware.com/reference/putcontractnote-1.md
  - https://developer.dealerware.com/reference/putdealershipaddress-1.md
  - https://developer.dealerware.com/reference/putdealershipcustomernote.md
  - https://developer.dealerware.com/reference/putdealershipemployeeroles-1.md
  - https://developer.dealerware.com/reference/putdealershiptelematicssettings-1.md
  - https://developer.dealerware.com/reference/putemployee-1.md
  - https://developer.dealerware.com/reference/putfleet-1.md
  - https://developer.dealerware.com/reference/putfleetsettings-1.md
  - https://developer.dealerware.com/reference/putissue-1.md
  - https://developer.dealerware.com/reference/putreservationcustomer-1.md
  - https://developer.dealerware.com/reference/putuser-1.md
  - https://developer.dealerware.com/reference/putuserpassword-1.md
  - https://developer.dealerware.com/reference/putuserpasswordreset-1.md
  - https://developer.dealerware.com/reference/putuserpreference-1.md
  - https://developer.dealerware.com/reference/putvehiclefleet-1.md
  - https://developer.dealerware.com/reference/putvehiclefleets-1.md
  - https://developer.dealerware.com/reference/querydnr-1.md
  - https://developer.dealerware.com/reference/updateadmincustomerinsurance-1.md
  merge:
    pages: 174
    deduped: 1048
    conflicts_kept_first: 0