openapi: 3.2.0
info:
  title: Audatex.APIGateway Image Capture API
  termsOfService: https://www.solera.com/legal/
  contact:
    name: Solera Development Team
    url: https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio
    email: development@solera.com
  license:
    name: License
    url: https://www.solera.com/legal/
  version: V1
servers:
- url: /APIGateway
security:
- Bearer: []
- Bearer: []
tags:
- name: ImageCapture
paths:
  /api/v1/ImageCapture:
    post:
      tags:
      - ImageCapture
      summary: Send image capture SMS
      description: This endpoint will allow you to send image capture SMS
      parameters:
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
      responses:
        '201':
          description: Returns a created response
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Sorry, an unexpected error has occurred
        '401':
          description: Returns an error if the user is not authorised
      operationId: postApiV1ImageCapture
      x-operation-id-source: derived
  /api/v1/ImageCapture/UsingTemplate:
    post:
      tags:
      - ImageCapture
      summary: Send image capture SMS using a template
      description: This endpoint will allow you to send image capture SMS using a template
      parameters:
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ImageCaptureUsingTemplateReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/ImageCaptureUsingTemplateReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ImageCaptureUsingTemplateReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ImageCaptureUsingTemplateReqViewModel'
      responses:
        '201':
          description: Returns a created response
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Returns an error if the user is not authorised
      operationId: postApiV1ImageCaptureUsingTemplate
      x-operation-id-source: derived
  /api/v1/ImageCapture/WithLink:
    post:
      tags:
      - ImageCapture
      summary: Send image capture SMS and get the link in the response
      description: This endpoint will allow you to send image capture SMS and get the link in the response
      parameters:
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
      responses:
        '201':
          description: Returns a created response including the link
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Sorry, an unexpected error has occurred
        '401':
          description: Returns an error if the user is not authorised
      operationId: postApiV1ImageCaptureWithLink
      x-operation-id-source: derived
  /api/v1/ImageCapture/WithQR:
    post:
      tags:
      - ImageCapture
      summary: Create image capture request with QR code
      description: This endpoint creates an image capture request with QR code and returns the SelfViewModel
      parameters:
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ImageCaptureReqViewModel'
      responses:
        '201':
          description: Returns a created response with SelfViewModel
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Sorry, an unexpected error has occurred
        '401':
          description: Returns an error if the user is not authorised
      operationId: postApiV1ImageCaptureWithQR
      x-operation-id-source: derived
  /api/v1/ImageCapture/{imageCaptureId}/WithQR:
    get:
      tags:
      - ImageCapture
      summary: Get QR code for image capture request
      description: This endpoint retrieves the QR code as a PNG image file
      parameters:
      - name: imageCaptureId
        in: path
        description: The id of the image capture
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns PNG image file
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '404':
          description: Returns an error if the image capture id is not found
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
        '401':
          description: Returns an error if the user is not authorised
      operationId: getApiV1ImageCaptureByImageCaptureIdWithQR
      x-operation-id-source: derived
  /api/v1/ImageCapture/{imageCaptureId}/Duplicate:
    post:
      tags:
      - ImageCapture
      summary: Duplicate an expired image capture
      description: This endpoint will allow you to duplicate an expired image capture
      parameters:
      - name: imageCaptureId
        in: path
        description: The id of the expired image capture
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Returns a created response
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureSelfViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Returns an error if the user is not authorised
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '404':
          description: Returns an error if the image request id is not found
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
      operationId: postApiV1ImageCaptureByImageCaptureIdDuplicate
      x-operation-id-source: derived
  /api/v1/ImageCapture/{imageCaptureId}:
    get:
      tags:
      - ImageCapture
      summary: Gets details about an image capture
      description: This API will allow you to get details of an image capture
      parameters:
      - name: imageCaptureId
        in: path
        description: The id of the image capture
        required: true
        schema:
          type: string
          format: uuid
      - name: scale
        in: query
        description: "Optional parameter. To which size the images of the image capture will escalated when they are returned.\n            Currently, only <em>NoScale</em> and <em>OneMP</em> (Default value) are supported. Other values in the list of available values are for future uses.\n            Use of default value is strongly recommended."
        schema:
          $ref: '#/components/schemas/ScaleTo'
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '200':
          description: Returns details of the image capture if found and if the image capture does not exist or was deleted, returns an empty response.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
        '401':
          description: Returns an error if the user is not authorised
        '500':
          description: Sorry, an unexpected error has occurred
      operationId: getApiV1ImageCaptureByImageCaptureId
      x-operation-id-source: derived
    delete:
      tags:
      - ImageCapture
      summary: Delete Image Request
      description: This endpoint will allow you to delete an Image Capture.
      parameters:
      - name: imageCaptureId
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns an Ok response
        '202':
          description: Returns an accepted response
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '401':
          description: Returns an error if the user is not authorized
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '404':
          description: Returns an error if the image request does not exist
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Sorry, an unexpected error has occurred
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
      operationId: deleteApiV1ImageCaptureByImageCaptureId
      x-operation-id-source: derived
  /api/v1/ImageCapture/{imageCaptureId}/integration:
    get:
      tags:
      - ImageCapture
      summary: Gets details about an image capture including the external image id
      description: 'This API will allow you to get details of an image capture without loading the Base64 image data.

        Only image IDs and metadata are returned.'
      parameters:
      - name: imageCaptureId
        in: path
        description: The id of the image capture
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns details of the image capture if found and if the image capture does not exist or was deleted, returns an empty response.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureResViewModel'
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '404':
          description: Returns an error if the image request id is not found
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '500':
          description: Sorry, an unexpected error has occurred
          content:
            text/plain:
              schema:
                type: object
                additionalProperties:
                  type: string
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
            text/json:
              schema:
                type: object
                additionalProperties:
                  type: string
        '401':
          description: Returns an error if the user is not authorized
      operationId: getApiV1ImageCaptureByImageCaptureIdIntegration
      x-operation-id-source: derived
  /api/v1/ImageCapture/Query/{imageCaptureId}:
    get:
      tags:
      - ImageCapture
      summary: Gets only some information about an image capture
      description: This API will allow you to get some information of an image capture
      parameters:
      - name: imageCaptureId
        in: path
        description: The id of the image capture
        required: true
        schema:
          type: string
          format: uuid
      - name: fieldsSet
        in: query
        schema:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/QueryField'
      - name: fields
        in: query
        schema:
          type: string
      - name: defaultFieldNames
        in: query
        schema:
          type: array
          items:
            type: string
      - name: fieldNames
        in: query
        schema:
          type: array
          items:
            type: string
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      responses:
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '200':
          description: Returns some information of the image capture
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureQueryResViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureQueryResViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureQueryResViewModel'
        '401':
          description: Returns an error if the user is not authorized
        '500':
          description: Sorry, an unexpected error has occurred
      operationId: getApiV1ImageCaptureQueryByImageCaptureId
      x-operation-id-source: derived
    post:
      tags:
      - ImageCapture
      summary: Gets only some information about an image capture
      description: This API will allow you to get some information of an image capture
      parameters:
      - name: imageCaptureId
        in: path
        description: The id of the image capture
        required: true
        schema:
          type: string
          format: uuid
      - name: X-Data-Region
        in: header
        description: Enter the region for the image capture to be stored. Example format 'solera-uk'
        required: true
        schema:
          type: string
      requestBody:
        description: The query parameters required of the image capture
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/QueryReqViewModel'
          application/json:
            schema:
              $ref: '#/components/schemas/QueryReqViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/QueryReqViewModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/QueryReqViewModel'
      responses:
        '400':
          description: Returns an error if the request fails validation
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '404':
          description: Returns an error if the image request id is not found
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '200':
          description: Returns some information of the image capture
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ImageCaptureQueryResViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureQueryResViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/ImageCaptureQueryResViewModel'
        '401':
          description: Returns an error if the user is not authorized
        '500':
          description: Sorry, an unexpected error has occurred
      operationId: postApiV1ImageCaptureQueryByImageCaptureId
      x-operation-id-source: derived
components:
  schemas:
    ImageCaptureStatusType:
      enum:
      - Pending
      - Expired
      - Completed
      type: string
    ScaleTo:
      enum:
      - NoScale
      - OneMP
      - TwoMP
      - FiveMP
      - TenMP
      type: string
    ImageCapturePageConfigurationVM:
      required:
      - pages
      type: object
      properties:
        pages:
          type: array
          items:
            $ref: '#/components/schemas/ImageCapturePageVM'
          description: List of pages that are to be displayed as part of the image request
      additionalProperties: false
    ImageCaptureAssetIdentifierReqVM:
      required:
      - identifier
      - value
      type: object
      properties:
        identifier:
          $ref: '#/components/schemas/AssetIdentifier'
        value:
          maxLength: 255
          minLength: 1
          type: string
          description: Value against the identifier
        assetProperties:
          $ref: '#/components/schemas/AssetPropertiesReqVM'
      additionalProperties: false
    ImageCaptureStylingVM:
      required:
      - buttonHex
      - primaryHex
      - secondaryHex
      type: object
      properties:
        logoId:
          type:
          - string
          - 'null'
          description: LogoId for entity logo mapping
          format: uuid
        logo:
          type:
          - string
          - 'null'
          description: Logo to be used when rendering the image capture on the UI. This must be 250KB or less of .png format data.
          format: byte
        primaryHex:
          minLength: 1
          pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
          type: string
          description: 'Primary Hex colour of the format #000000. Used for header background.'
        secondaryHex:
          minLength: 1
          pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
          type: string
          description: 'Secondary Hex colour of the format #000000. Used for header border and submit button'
        buttonHex:
          minLength: 1
          pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$
          type: string
          description: 'Button Hex colour of the format #000000. Used for the primary buttons'
      additionalProperties: false
    ImageCaptureImageResVM:
      type: object
      properties:
        id:
          type: string
          format: uuid
        externalImageId:
          type:
          - string
          - 'null'
          format: uuid
        pageType:
          $ref: '#/components/schemas/PageType'
        tags:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Tag'
        isFromLibrary:
          type: boolean
          readOnly: true
        pageId:
          type:
          - string
          - 'null'
          format: uuid
        quality:
          $ref: '#/components/schemas/Quality'
        data:
          type:
          - string
          - 'null'
      additionalProperties: false
    ImageCaptureDateViewModel:
      type: object
      properties:
        utc:
          type: string
          format: date-time
        local:
          type: string
          format: date-time
      additionalProperties: false
    ImageCaptureUsingTemplateReqViewModel:
      required:
      - templateName
      type: object
      properties:
        linkExpiryDays:
          maximum: 30
          minimum: 1
          type:
          - integer
          - 'null'
          description: Set the time in days that the image request link will expire in.
          format: int32
        language:
          type:
          - string
          - 'null'
          description: Set the language for the image capture UI. Optional; if not provided, defaults to "en-GB".
        timeZone:
          $ref: '#/components/schemas/TimeZone'
        styling:
          $ref: '#/components/schemas/ImageCaptureStylingVM'
        pageConfiguration:
          $ref: '#/components/schemas/ImageCapturePageConfigurationVM'
        clientReferenceId:
          maxLength: 255
          type:
          - string
          - 'null'
          description: Customer unique reference Id
        asset:
          $ref: '#/components/schemas/ImageCaptureAssetIdentifierReqVM'
        communication:
          $ref: '#/components/schemas/ImageCaptureUsingTemplateCommunicationVM'
        disableGalleryUpload:
          type:
          - boolean
          - 'null'
          description: Flag to set if a user can upload images from their gallery on their mobile device
        termsAndConditionsUrl:
          maxLength: 500
          type:
          - string
          - 'null'
          description: Set the Terms and Conditions Url, a default will display if null
        settings:
          description: Settings configuration for image capture
        enableVin:
          type:
          - boolean
          - 'null'
          description: "Enable the vin validation, it means when a vin number is sent, the global vin is \ncalled, if this property is false, the endpoint is not called to get the car\nidentification."
        disableLink:
          type:
          - boolean
          - 'null'
          description: Flag to indicate whether a user is allowed to send links other than the GIC link.
        country:
          $ref: '#/components/schemas/RequestCountry'
        templateName:
          minLength: 1
          type: string
          description: get templates by template name
      additionalProperties: false
    ImageCaptureCommunicationVM:
      required:
      - from
      - recipient
      - type
      type: object
      properties:
        recipient:
          $ref: '#/components/schemas/ImageCaptureRecipientVM'
        from:
          maxLength: 150
          minLength: 1
          type: string
          description: The name of the sender
        message:
          maxLength: 300
          type:
          - string
          - 'null'
          description: The message to be sent in SMS. The API will substitute {IC_URL} for the image request link and {IC_PIN} for the image request pin.
        type:
          $ref: '#/components/schemas/CommunicationType'
        shortUrl:
          maxLength: 50
          type:
          - string
          - 'null'
          description: The short Url for the image capture link
        enableLineTypeIntelligence:
          type: boolean
          description: 'Enable the line type intelligence, it means when there is a communication,

            we validate the line type of the phone number.'
        template:
          type:
          - string
          - 'null'
        variables:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        reminders:
          $ref: '#/components/schemas/ReminderConfigModel'
      additionalProperties: false
    ReminderConfigModel:
      type: object
      properties:
        delays:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
        reminderMessage:
          type:
          - string
          - 'null'
      additionalProperties: false
    CommunicationStatus:
      enum:
      - Sent
      - Delivered
      - Undelivered
      - Error
      - Unknown
      type: string
    Tag:
      enum:
      - wheel
      - front
      - rear
      - left
      - right
      - interior
      - mileage
      - vin
      - centre
      - roof
      - window
      - library
      - digitalSignature
      - wideAngle
      - selfPortrait
      - fullView
      - closeUp
      type: string
    ImageCapturePageVM:
      required:
      - displayOrder
      - pageType
      type: object
      properties:
        id:
          type: string
          description: Page Id
          format: uuid
        pageType:
          $ref: '#/components/schemas/PageType'
        overrideTitle:
          maxLength: 500
          type:
          - string
          - 'null'
          description: If the value is null then the defaulting title is shown
        overrideText:
          maxLength: 4000
          type:
          - string
          - 'null'
          description: 'If the value is null then the defaulting text is shown

            This will be ignored in Damage Photos page'
        heroImageId:
          type:
          - string
          - 'null'
          description: If the value is not found then the default hero image is shown
          format: uuid
        surveySchema:
          description: 'Set the value of the Survey Schema for SurveyPages

            This will be ignored in Damage Photos page'
        acknowledgeText:
          type:
          - string
          - 'null'
          description: Set the value of the checkbox from Survey page and Digital Signature page
        isImageRequired:
          type: boolean
          description: 'If set to true then an image is required for this page.

            This will be ignored in Confirm Vehicle page and Damage Photos page, as pictures

            are mandatory for those pages.'
        minimumImages:
          maximum: 10
          minimum: 1
          type:
          - integer
          - 'null'
          description: 'Minimum number of images that must be uploaded in this page.

            if <em>IsImageRequired</em> is set to false, then this value is ignored.'
          format: int32
        maximumImages:
          maximum: 2147483647
          minimum: 1
          type:
          - integer
          - 'null'
          description: Maximum number of images that must be uploaded in this page.
          format: int32
        isVideoRequired:
          type: boolean
          description: If set to true then a video is required for this page.
        displayOrder:
          maximum: 99
          minimum: 1
          type: integer
          description: Sets the display order for the page
          format: int32
        isOnlyDamagePhotoRequired:
          type: boolean
          description: 'If set to true then only damage image is required for Damage Photos page.

            This will be ignored in the other page types'
        isMultiplePictureEnable:
          type:
          - boolean
          - 'null'
          description: If set to true then multiple pictures can be uploaded for this page
        initialDamageTitle:
          maxLength: 500
          type:
          - string
          - 'null'
          description: 'If the value is null then the defaulting title is shown

            Only available for Damage Photos page, on the first step (Indicate damage)'
        initialDamageText:
          maxLength: 4000
          type:
          - string
          - 'null'
          description: 'If the value is null then the defaulting text is shown

            Only available for Damage Photos page, on the first step (Indicate damage)'
        photosDamageTitle:
          maxLength: 500
          type:
          - string
          - 'null'
          description: 'If the value is null then the defaulting title is shown

            Only available for Damage Photos page, on the second step (Required photos)'
        photosDamageText:
          maxLength: 4000
          type:
          - string
          - 'null'
          description: 'If the value is null then the defaulting text is shown

            Only available for Damage Photos page, on the second step (Required photos)'
        completeDamageTitle:
          maxLength: 500
          type:
          - string
          - 'null'
          description: 'If the value is null then the defaulting title is shown

            Only available for Damage Photos page, on the third step (Damage summary)'
        completeDamageText:
          maxLength: 4000
          type:
          - string
          - 'null'
          description: 'If the value is null then the defaulting text is shown

            Only available for Damage Photos page, on the third step (Damage summary)'
        pointOfImpact:
          description: Set the value of the PointOfImpact for PointOfImpactPages
        disableGalleryUpload:
          type:
          - boolean
          - 'null'
          description: If set to true then pictures from gallery can not be uploaded for this page
        units:
          type:
          - string
          - 'null'
          description: Only If the mileage page is selected, this field will hold the unit value
        validateVin:
          type:
          - integer
          - 'null'
          description: 'If set, the VIN lenght will be validated to the number provided, only 16 and 17 are allowed

            Only available for Confirm Vehicle page'
          format: int32
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Set the list of tags for this page
        isAudioRequired:
          type: boolean
          description: If set to true then audio is required for this page
      additionalProperties: false
    ImageCaptureAssetIdentifierResVM:
      type: object
      properties:
        identifier:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
        properties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageCaptureAssetPropertyRespVM'
      additionalProperties: false
    ImageCaptureAudiosResVM:
      type: object
      properties:
        id:
          type: string
          format: uuid
        pageId:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
      additionalProperties: false
    ImageCaptureAssetPropertyRespVM:
      type: object
      properties:
        key:
          type:
          - string
          - 'null'
        value:
          type:
          - string
          - 'null'
      additionalProperties: false
    ImageCaptureReqViewModel:
      required:
      - linkExpiryDays
      - pageConfiguration
      - timeZone
      type: object
      properties:
        linkExpiryDays:
          maximum: 30
          minimum: 1
          type: integer
          description: Set the time in days that the image request link will expire in.
          format: int32
        language:
          type:
          - string
          - 'null'
          description: Set the language for the image capture UI. Optionally supply the culture code (RFC 4646), e.g. 'en-US'; defaults to 'en-GB' if not provided.
        timeZone:
          $ref: '#/components/schemas/TimeZone'
        styling:
          $ref: '#/components/schemas/ImageCaptureStylingVM'
        pageConfiguration:
          $ref: '#/components/schemas/ImageCapturePageConfigurationVM'
        clientReferenceId:
          maxLength: 255
          type:
          - string
          - 'null'
          description: Customer unique reference Id
        asset:
          $ref: '#/components/schemas/ImageCaptureAssetIdentifierReqVM'
        communication:
          $ref: '#/components/schemas/ImageCaptureCommunicationVM'
        disableGalleryUpload:
          type: boolean
          description: Flag to set if a user can upload images from their gallery on their mobile device
        termsAndConditionsUrl:
          maxLength: 500
          type:
          - string
          - 'null'
          description: Set the Terms and Conditions Url, a default will display if null
        settings:
          description: Settings configuration for image capture
        enableVin:
          type: boolean
          description: "Enable the vin validation, it means when a vin number is sent, the global vin is \ncalled, if this property is false, the endpoint is not called to get the car\nidentification."
        disableLink:
          type: boolean
          description: Flag to indicate whether a user is allowed to send links other than the GIC link.
        country:
          $ref: '#/components/schemas/RequestCountry'
        templateName:
          type:
          - string
          - 'null'
          description: get templates by template name
        jobId:
          type:
          - string
          - 'null'
          description: Job for the Image Capture to be linked with
          format: uuid
      additionalProperties: false
    CommunicationType:
      enum:
      - SMS
      - Whatsapp
      type: string
    ErrorModel:
      type: object
      properties:
        code:
          type:
          - string
          - 'null'
        message:
          type:
          - string
          - 'null'
        isNoError:
          type: boolean
          readOnly: true
        isCreated:
          type: boolean
          readOnly: true
        isAccepted:
          type: boolean
          readOnly: true
        isInternalError:
          type: boolean
          readOnly: true
        isBadRequest:
          type: boolean
          readOnly: true
        isNotFoundError:
          type: boolean
          readOnly: true
        isUnauthorizedCodeError:
          type: boolean
          readOnly: true
        isBadGatewayError:
          type: boolean
          readOnly: true
        getHttpCode:
          type: integer
          format: int32
          readOnly: true
      additionalProperties: false
    TimeZone:
      enum:
      - Dateline_Standard_Time
      - Hawaiian_Standard_Time
      - Alaskan_Standard_Time
      - Pacific_Standard_Time
      - Pacific_Standard_Time_Mexico
      - Mountain_Standard_Time
      - Mountain_Standard_Time_Mexico
      - US_Mountain_Standard_Time
      - Canada_Central_Standard_Time
      - Central_America_Standard_Time
      - Central_Standard_Time
      - Central_Standard_Time_Mexico
      - Eastern_Standard_Time
      - SA_Pacific_Standard_Time
      - US_Eastern_Standard_Time
      - Atlantic_Standard_Time
      - Central_Brazilian_Standard_Time
      - Pacific_SA_Standard_Time
      - SA_Western_Standard_Time
      - Venezuela_Standard_Time
      - Paraguay_Standard_Time
      - Newfoundland_Standard_Time
      - E_South_America_Standard_Time
      - Greenland_Standard_Time
      - Montevideo_Standard_Time
      - SA_Eastern_Standard_Time
      - Argentina_Standard_Time
      - Mid_Atlantic_Standard_Time
      - Azores_Standard_Time
      - Cabo_Verde_Standard_Time
      - GMT_Standard_Time
      - Greenwich_Standard_Time
      - Morocco_Standard_Time
      - UTC
      - Central_Europe_Standard_Time
      - Central_European_Standard_Time
      - Romance_Standard_Time
      - W_Central_Africa_Standard_Time
      - W_Europe_Standard_Time
      - Namibia_Standard_Time
      - E_Europe_Standard_Time
      - Egypt_Standard_Time
      - FLE_Standard_Time
      - GTB_Standard_Time
      - Israel_Standard_Time
      - Jordan_Standard_Time
      - Middle_East_Standard_Time
      - South_Africa_Standard_Time
      - Syria_Standard_Time
      - Turkey_Standard_Time
      - Arab_Standard_Time
      - Arabic_Standard_Time
      - E_Africa_Standard_Time
      - Kaliningrad_Standard_Time
      - Russian_Standard_Time
      - Iran_Standard_Time
      - Arabian_Standard_Time
      - Azerbaijan_Standard_Time
      - Caucasus_Standard_Time
      - Afghanistan_Standard_Time
      - Georgian_Standard_Time
      - Mauritius_Standard_Time
      - Ekaterinburg_Standard_Time
      - West_Asia_Standard_Time
      - India_Standard_Time
      - Sri_Lanka_Standard_Time
      - Nepal_Standard_Time
      - Pakistan_Standard_Time
      - Central_Asia_Standard_Time
      - N_Central_Asia_Standard_Time
      - Myanmar_Standard_Time
      - Bangladesh_Standard_Time
      - North_Asia_Standard_Time
      - SE_Asia_Standard_Time
      - China_Standard_Time
      - North_Asia_East_Standard_Time
      - Singapore_Standard_Time
      - Taipei_Standard_Time
      - W_Australia_Standard_Time
      - Ulaanbaatar_Standard_Time
      - Korea_Standard_Time
      - Tokyo_Standard_Time
      - Yakutsk_Standard_Time
      - AUS_Central_Standard_Time
      - Central_Australia_Standard_Time
      - AUS_Eastern_Standard_Time
      - E_Australia_Standard_Time
      - Tasmania_Standard_Time
      - Vladivostok_Standard_Time
      - West_Pacific_Standard_Time
      - Central_Pacific_Standard_Time
      - Magadan_Standard_Time
      - Fiji_Standard_Time
      - New_Zealand_Standard_Time
      - Tonga_Standard_Time
      - Samoa_Standard_Time
      type: string
    ImageCaptureCustomerCommentResVM:
      type: object
      properties:
        comment:
          type:
          - string
          - 'null'
      additionalProperties: false
    Quality:
      enum:
      - Ok
      - TooBlurry
      - TooDark
      - TooBright
      type: string
    ImageCaptureRecipientVM:
      required:
      - dialingCode
      - mobileNumber
      type: object
      properties:
        dialingCode:
          maxLength: 5
          minLength: 1
          type: string
          description: Dialing code for mobile number. Format +XX
        mobileNumber:
          maxLength: 11
          minLength: 8
          type: string
          description: The Mobile number where Image capture SMS will be sent.
        lineType:
          type:
          - string
          - 'null'
          description: The LineType of the mobile number.
      additionalProperties: false
    ImageCaptureCustomerSurveyRatingResVM:
      type: object
      properties:
        starRating:
          type: integer
          format: int32
        comment:
          type:
          - string
          - 'null'
        bubbles:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/BubbleModel'
      additionalProperties: false
    WarningModel:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
      additionalProperties: false
    AssetIdentifier:
      enum:
      - VIN
      type: string
    ImageCaptureTimeZoneVM:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        offset:
          type: integer
          format: int32
      additionalProperties: false
    RequestCountry:
      enum:
      - DZ
      - AO
      - AR
      - AU
      - AT
      - AZ
      - BH
      - BY
      - BE
      - BA
      - BR
      - BN
      - BG
      - KH
      - CA
      - CL
      - CN
      - CO
      - CR
      - HR
      - CY
      - CZ
      - DK
      - EE
      - FI
      - FR
      - GE
      - DE
      - GR
      - HK
      - HU
      - IN
      - ID
      - IE
      - IL
      - IT
      - JP
      - KZ
      - KE
      - KR
      - KW
      - LA
      - LV
      - LB
      - LT
      - LU
      - MK
      - MY
      - MT
      - MU
      - MX
      - MD
      - ME
      - MA
      - MM
      - NL
      - NZ
      - 'NO'
      - OM
      - PA
      - PE
      - PH
      - PL
      - PT
      - PR
      - QA
      - RO
      - RU
      - SA
      - RS
      - SG
      - SK
      - SI
      - ZA
      - ES
      - LK
      - SE
      - CH
      - TW
      - TH
      - TN
      - TR
      - UA
      - AE
      - GB
      - US
      - UY
      - VE
      - VN
      type: string
    QueryField:
      enum:
      - Id
      - Status
      - IsLinkOpened
      - ExpiryDays
      - DeliveryStatus
      - DateSent
      - RemindersSent
      - Link
      - ClientReferenceId
      - VIN
      - QRLink
      type: string
    ImageCaptureSelfViewModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        self:
          type:
          - string
          - 'null'
        responseCommunication:
          $ref: '#/components/schemas/ImageCaptureResCommunicationVM'
        error:
          $ref: '#/components/schemas/ErrorModel'
        warnings:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/WarningModel'
      additionalProperties: false
    ImageCaptureCommunicationResVM:
      type: object
      properties:
        id:
          type: string
          format: uuid
        recipient:
          $ref: '#/components/schemas/ImageCaptureRecipientVM'
        message:
          type:
          - string
          - 'null'
        from:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/CommunicationType'
        status:
          $ref: '#/components/schemas/ImageCaptureStatusType'
        deliveryStatus:
          $ref: '#/components/schemas/CommunicationStatus'
        dateSent:
          $ref: '#/components/schemas/ImageCaptureDateViewModel'
        enableLineTypeIntelligence:
          type: boolean
        template:
          type:
          - string
          - 'null'
        variables:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        reminders:
          $ref: '#/components/schemas/ReminderConfigModel'
      additionalProperties: false
    BubbleModel:
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    PageType:
      enum:
      - FrontLeft
      - FrontRight
      - RearRight
      - RearLeft
      - Mileage
      - VIN
      - AdHoc
      - Front
      - SideLeft
      - SideRight
      - Rear
      - CloseUp
      - LicenseGeneric
      - FrontInterior
      - RearInterior
      - PoliceReport
      - RegistrationDocument
      - Generic
      - LicenseUAE
      - Wheels
      - Blank
      - ConfirmVehicle
      - DamagePhotos
      - Keys
      - Survey
      - DigitalSignature
      - CloseFrontLeft
      - CloseFrontRight
      - CloseRearRight
      - CloseRearLeft
      - CloseFront
      - CloseSideLeft
      - CloseSideRight
      - CloseRear
      - FrontWindscreen
      - RearWindscreen
      - LicensePlate
      - VideoUpload
      - PointOfImpact
      - DamageCloseUps
      - Audio
      - SelfPortrait
      type: string
    ValidationProblemDetails:
      type: object
      properties:
        errors:
          type:
          - object
          - 'null'
          additionalProperties:
            type: array
            items:
              type: string
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    ImageCaptureQueryResViewModel:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
          format: uuid
        status:
          $ref: '#/components/schemas/ImageCaptureStatusType'
        deliveryStatus:
          type:
          - string
          - 'null'
        dateSent:
          type:
          - string
          - 'null'
          format: date-time
        isLinkOpened:
          type:
          - boolean
          - 'null'
        expiryDays:
          type:
          - integer
          - 'null'
          format: int32
        remindersSent:
          type:
          - integer
          - 'null'
          format: int32
        link:
          type:
          - string
          - 'null'
        clientReferenceId:
          type:
          - string
          - 'null'
        vin:
          type:
          - string
          - 'null'
        qrLink:
          type:
          - string
          - 'null'
      additionalProperties: false
    ImageCaptureResViewModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
        clientReferenceId:
          type:
          - string
          - 'null'
        link:
          type:
          - string
          - 'null'
        dateCreated:
          $ref: '#/components/schemas/ImageCaptureDateViewModel'
        isLinkOpened:
          type: boolean
        dateOpened:
          $ref: '#/components/schemas/ImageCaptureDateViewModel'
        dateCompleted:
          $ref: '#/components/schemas/ImageCaptureDateViewModel'
        status:
          $ref: '#/components/schemas/ImageCaptureStatusType'
        linkExpiryDays:
          type: integer
          format: int32
        jobId:
          type:
          - string
          - 'null'
          format: uuid
        images:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageCaptureImageResVM'
        videos:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageCaptureVideosResVM'
        audios:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageCaptureAudiosResVM'
        styling:
          $ref: '#/components/schemas/ImageCaptureStylingVM'
        pageConfiguration:
          $ref: '#/components/schemas/ImageCapturePageConfigurationVM'
        language:
          type:
          - string
          - 'null'
          description: Language culture code for the image request UI. (RFC 4646), i.e. 'en-US'
        accessCode:
          type:
          - string
          - 'null'
        qrLink:
          type:
          - string
          - 'null'
          description: Base64-encoded QR code image containing IC_Link/PIN
        pin:
          type:
          - string
          - 'null'
        originatingRegion:
          type:
          - string
          - 'null'
        timeZone:
          $ref: '#/components/schemas/ImageCaptureTimeZoneVM'
        asset:
          $ref: '#/components/schemas/ImageCaptureAssetIdentifierResVM'
        communications:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageCaptureCommunicationResVM'
        customerSurveyRating:
          $ref: '#/components/schemas/ImageCaptureCustomerSurveyRatingResVM'
        customerComment:
          $ref: '#/components/schemas/ImageCaptureCustomerCommentResVM'
        disableGalleryUpload:
          type: boolean
          description: Flag to set if a user can upload images from their gallery on their mobile device
        termsAndConditionsUrl:
          type:
          - string
          - 'null'
        userInputs:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ImageCaptureUserInputResVM'
        settings: {}
        country:
          $ref: '#/components/schemas/RequestCountry'
        enableVin:
          type: boolean
          description: "Enable the vin validation, it means when a vin number is sent, the global vin is \ncalled, if this property is false, the endpoint is not called to get the car\nidentification."
        disableLink:
          type: boolean
        lastVisitedPage:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    AssetPropertiesReqVM:
      required:
      - axManufacturer
      - axModel
      - axModelOptions
      - axSubModel
      - bodyType
      - make
      - model
      - year
      type: object
      properties:
        make:
          minLength: 1
          type: string
        model:
          minLength: 1
          type: string
        year:
          minLength: 1
          type: string
        bodyType:
          minLength: 1
          type: string
        axManufacturer:
          minLength: 1
          type: string
        axModel:
          minLength: 1
          type: string
        axSubModel:
          minLength: 1
          type: string
        axModelOptions:
          minLength: 1
          type: string
      additionalProperties: false
    ImageCaptureUsingTemplateCommunicationVM:
      required:
      - recipient
      type: object
      properties:
        recipient:
          $ref: '#/components/schemas/ImageCaptureRecipientVM'
        from:
          maxLength: 150
          type:
          - string
          - 'null'
          description: The name of the sender
        message:
          maxLength: 300
          type:
          - string
          - 'null'
          description: The message to be sent in SMS. The API will substitute {IC_URL} for the image request link and {IC_PIN} for the image request pin.
        type:
          $ref: '#/components/schemas/CommunicationType'
        shortUrl:
          maxLength: 50
          type:
          - string
          - 'null'
          description: The short Url for the image capture link
        template:
          type:
          - string
          - 'null'
        variables:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        reminders:
          $ref: '#/components/schemas/ReminderConfigModel'
      additionalProperties: false
    ImageCaptureVideosResVM:
      type: object
      properties:
        id:
          type: string
          format: uuid
        pageId:
          type: string
          format: uuid
        name:
          type:
          - string
          - 'null'
        url:
          type:
          - string
          - 'null'
      additionalProperties: false
    QueryReqViewModel:
      type: object
      properties:
        fieldsSet:
          uniqueItems: true
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/QueryField'
        fields:
          type:
          - string
          - 'null'
        defaultFieldNames:
          type:
          - array
          - 'null'
          items:
            type: string
          readOnly: true
        fieldNames:
          type:
          - array
          - 'null'
          items:
            type: string
          readOnly: true
      additionalProperties: false
    ImageCaptureResCommunicationVM:
      type: object
      properties:
        communicationId:
          type:
          - string
          - 'null'
          format: uuid
        status:
          $ref: '#/components/schemas/ImageCaptureStatusType'
        dateSent:
          type: string
          format: date-time
        dateReceived:
          type: string
          format: date-time
        errorMessage:
          type:
          - string
          - 'null'
      additionalProperties: false
    ImageCaptureUserInputResVM:
      type: object
      properties:
        userInputId:
          type: string
          format: uuid
        property:
          type:
          - string
          - 'null'
        unit:
          type:
          - string
          - 'null'
        propertyValue: {}
        tags:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: "JWT Authorization header using the Bearer scheme. \n\n Enter 'Bearer' [space] and then your token in the text input below.\n\nExample: \"Bearer 12345abcdef\""
      name: Authorization
      in: header