{
  "openapi": "3.0.0",
  "info": {
    "title": "ValueChecker API",
    "description": "The ValueChecker Application Programming Interface.",
    "version": "0.150.1",
    "x-logo": {
      "url": "https://files.valuechecker.net/images/default-category-images/Value-Checker_top_bar_logo.png",
      "backgroundColor": "#FFFFFF",
      "altText": "ValueChecker logo"
    },
    "contact": {
      "name": "Contact",
      "url": "https://www.valuechecker.ai/contact/",
      "email": "support@valuechecker.ai"
    }
  },
  "tags": [
    {
      "name": "Account"
    },
    {
      "name": "Client References"
    },
    {
      "name": "Product Search"
    },
    {
      "name": "Appraisals"
    },
    {
      "name": "Valuation"
    },
    {
      "name": "Appraisal Statuses"
    },
    {
      "name": "Reports"
    },
    {
      "name": "Forensics"
    },
    {
      "name": "Customer Portal"
    }
  ],
  "externalDocs": {
    "description": "PDF Documentation (official)",
    "url": "https://www.valuechecker.ai/docs/api/pdf"
  },
  "servers": [
    {
      "url": "https://api.valuechecker.net/",
      "description": "ValueChecker API URL."
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "description": "Note! Prefix your API key with `apiKey` and a space, for example `apiKey YOUR_API_KEY`."
      }
    },
    "parameters": {
      "session-id": {
        "name": "session-id",
        "in": "query",
        "schema": {
          "type": "string"
        },
        "example": "a1b2c3d4e5f6g7h8i9j0",
        "description": "Optional session identifier of the user."
      },
      "client_id": {
        "name": "client_id",
        "in": "query",
        "schema": {
          "type": "integer"
        },
        "example": "10",
        "description": "The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional."
      },
      "client_reference_name": {
        "name": "name",
        "in": "query",
        "schema": {
          "type": "string"
        },
        "example": "Reference 322",
        "description": "Optional parameter returning only matched client reference name. Returns single client reference or empty object when not found."
      },
      "client_reference_id": {
        "name": "client_reference_id",
        "in": "path",
        "schema": {
          "type": "integer"
        },
        "required": true,
        "description": "The client reference identifier.",
        "example": "9337"
      },
      "appraisal_id": {
        "name": "appraisal_id",
        "in": "path",
        "schema": {
          "type": "integer"
        },
        "required": true,
        "description": "The appraisal identifier.",
        "example": "97771"
      },
      "page": {
        "name": "page",
        "in": "query",
        "schema": {
          "type": "integer"
        },
        "example": "2",
        "description": "Page number for response pagination."
      },
      "page_size": {
        "name": "page_size",
        "in": "query",
        "schema": {
          "type": "integer"
        },
        "example": "30",
        "description": "Page size for response pagination."
      },
      "attachments": {
        "name": "attachments",
        "in": "query",
        "schema": {
          "type": "boolean"
        },
        "example": "true",
        "description": "Optional flag determining if file attachments should be present."
      }
    },
    "responses": {
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string"
                },
                "event_code": {
                  "type": "string"
                },
                "event_dict": {
                  "type": "object",
                  "properties": {
                    "event_severity": {
                      "type": "string"
                    },
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                }
              }
            },
            "example": {
              "error": "Bad Request",
              "event_code": "ERIT01",
              "event_dict": {
                "event_severity": "ERROR",
                "title": "Bad Request",
                "description": "Invalid parameters provided"
              }
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string"
                },
                "event_code": {
                  "type": "string"
                },
                "event_dict": {
                  "type": "object",
                  "properties": {
                    "event_severity": {
                      "type": "string"
                    },
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                }
              }
            },
            "example": {
              "error": "Invalid Authorization header",
              "event_code": "ERIT00",
              "event_dict": {
                "event_severity": "ERROR",
                "title": "Invalid Authorization header",
                "description": "Please provide the right authorization token"
              }
            }
          }
        }
      },
      "403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "error": {
                  "type": "string"
                },
                "event_code": {
                  "type": "string"
                },
                "event_dict": {
                  "type": "object",
                  "properties": {
                    "event_severity": {
                      "type": "string"
                    },
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                }
              }
            },
            "example": {
              "error": "Forbidden",
              "event_code": "ERIT02",
              "event_dict": {
                "event_severity": "ERROR",
                "title": "Forbidden",
                "description": "Access denied"
              }
            }
          }
        }
      }
    },
    "schemas": {
      "PriceRange": {
        "type": "object",
        "properties": {
          "price_min": {
            "type": "number",
            "multipleOf": 0.01
          },
          "price_max": {
            "type": "number",
            "multipleOf": 0.01
          },
          "shop_count": {
            "type": "integer"
          },
          "price_date": {
            "type": "string"
          }
        }
      },
      "Spec": {
        "type": "object",
        "properties": {
          "spec_id": {
            "type": "integer"
          },
          "spec_value": {
            "type": "string"
          },
          "spec_value_display": {
            "type": "string"
          },
          "spec_value_numeric": {
            "type": "number"
          },
          "spec_name": {
            "type": "string"
          },
          "spec_name_display": {
            "type": "string"
          }
        }
      },
      "SearchSuggestionProduct": {
        "type": "object",
        "properties": {
          "product_name": {
            "type": "string"
          },
          "pic_url": {
            "type": "string"
          },
          "product_pic_url": {
            "type": "string"
          },
          "pid": {
            "type": "integer"
          },
          "cid": {
            "type": "integer"
          },
          "specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Spec"
            }
          },
          "price": {
            "$ref": "#/components/schemas/PriceRange"
          }
        }
      },
      "SearchProduct": {
        "type": "object",
        "properties": {
          "product_name": {
            "type": "string"
          },
          "pic_url": {
            "type": "string"
          },
          "product_picture_url": {
            "type": "string"
          },
          "pid": {
            "type": "integer"
          },
          "cid": {
            "type": "integer"
          },
          "client_category": {
            "type": "string"
          },
          "client_category_id": {
            "type": "integer"
          },
          "specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Spec"
            }
          },
          "price": {
            "$ref": "#/components/schemas/PriceRange"
          },
          "price_clusters": {
            "$ref": "#/components/schemas/PriceClusters"
          },
          "child_products": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "child_product_contents": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SearchSuggestionProduct"
            }
          }
        }
      },
      "SearchProductMetadata": {
        "type": "object",
        "properties": {
          "used_query": {
            "type": "string"
          },
          "category": {
            "type": "object",
            "properties": {
              "requested_client_category_id": {
                "type": "integer"
              },
              "requested_client_category": {
                "type": "string"
              },
              "predicted_client_category_id": {
                "type": "integer"
              },
              "predicted_client_category": {
                "type": "string"
              },
              "predicted_certainty": {
                "type": "number"
              },
              "category_switched": {
                "type": "boolean"
              }
            }
          }
        }
      },
      "PriceClusterValue": {
        "type": "object",
        "properties": {
          "udc_id": {
            "type": "integer"
          },
          "pid": {
            "type": "integer"
          },
          "group": {
            "type": "string"
          },
          "price": {
            "type": "number",
            "multipleOf": 0.01
          },
          "count": {
            "type": "integer"
          },
          "percentage": {
            "type": "number"
          },
          "min_price": {
            "type": "number",
            "multipleOf": 0.01
          },
          "max_price": {
            "type": "number",
            "multipleOf": 0.01
          }
        }
      },
      "PriceClusters": {
        "type": "object",
        "properties": {
          "low": {
            "$ref": "#/components/schemas/PriceClusterValue"
          },
          "medium": {
            "$ref": "#/components/schemas/PriceClusterValue"
          },
          "high": {
            "$ref": "#/components/schemas/PriceClusterValue"
          }
        }
      },
      "ClaimedProduct": {
        "type": "object",
        "properties": {
          "pid": {
            "type": "integer"
          },
          "master_name": {
            "type": "string"
          },
          "product_name": {
            "type": "string"
          },
          "vcid": {
            "type": "integer"
          },
          "cid": {
            "type": "integer"
          },
          "pic_url": {
            "type": "string"
          },
          "product_pic_url": {
            "type": "string"
          },
          "product_url": {
            "type": "string"
          },
          "specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Spec"
            }
          },
          "in_stock": {
            "type": "boolean"
          },
          "query_at_limit": {
            "type": "boolean"
          },
          "client_category_id": {
            "type": "integer"
          },
          "client_category": {
            "type": "string"
          }
        }
      },
      "GroupedPricesProduct": {
        "type": "object",
        "properties": {
          "pid": {
            "type": "integer"
          },
          "sid": {
            "type": "integer"
          },
          "vcid": {
            "type": "integer"
          },
          "source_internal_id": {
            "type": "string"
          },
          "master_name": {
            "type": "string"
          },
          "product_name": {
            "type": "string"
          },
          "master_pic_url": {
            "type": "string"
          },
          "pic_url": {
            "type": "string"
          },
          "product_pic_url": {
            "type": "string"
          },
          "product_url": {
            "type": "string"
          },
          "brand": {
            "type": "string"
          },
          "price": {
            "type": "object",
            "properties": {
              "price_url": {
                "type": "string"
              }
            }
          },
          "rp_first_choice": {
            "type": "boolean"
          },
          "specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Spec"
            }
          },
          "same_alid_as_cp": {
            "type": "boolean"
          },
          "score_perfect": {
            "type": "boolean"
          },
          "score": {
            "type": "number"
          }
        }
      },
      "Shop": {
        "type": "object",
        "properties": {
          "shop_name": {
            "type": "string"
          },
          "shop_status": {
            "type": "integer"
          },
          "shop_score": {
            "type": "integer"
          }
        }
      },
      "PriceListElement": {
        "type": "object",
        "properties": {
          "shop_product_name": {
            "type": "string"
          },
          "currency": {
            "type": "string"
          },
          "total_price": {
            "type": "number",
            "multipleOf": 0.01
          },
          "base_price": {
            "type": "number",
            "multipleOf": 0.01
          },
          "price_date": {
            "type": "string"
          },
          "offer_id": {
            "type": "integer"
          },
          "offer_url": {
            "type": "string"
          },
          "international": {
            "type": "boolean"
          },
          "is_refurbished": {
            "type": "boolean"
          },
          "in_stock": {
            "type": "boolean"
          },
          "blocked": {
            "type": "boolean"
          },
          "country_code": {
            "type": "string"
          },
          "product": {
            "$ref": "#/components/schemas/GroupedPricesProduct"
          },
          "shop": {
            "$ref": "#/components/schemas/Shop"
          },
          "filtered_price": {
            "type": "boolean"
          },
          "outside_price_range": {
            "type": "boolean"
          }
        }
      },
      "AppraisalMetadata": {
        "type": "object",
        "properties": {
          "ongoing_count": {
            "type": "integer",
            "description": "Count of ongoing calculation of RCV."
          },
          "timestamp": {
            "type": "string",
            "description": "Timestamp of the response."
          },
          "appraisals": {
            "type": "object",
            "properties": {
              "current_page": {
                "type": "integer",
                "description": "Current response pagination page number"
              },
              "page_size": {
                "type": "integer",
                "description": "Current response pagination page size"
              },
              "total_pages": {
                "type": "integer",
                "description": "Total pages in the Client Reference"
              },
              "total_items": {
                "type": "integer",
                "description": "Total items in the Client Reference"
              }
            }
          }
        }
      },
      "Appraisal": {
        "type": "object",
        "properties": {
          "appraisal_id": {
            "type": "integer"
          },
          "client_reference_id": {
            "type": "integer"
          },
          "cpid": {
            "type": "integer"
          },
          "rpid": {
            "type": "integer"
          },
          "create_time": {
            "type": "string"
          },
          "update_time": {
            "type": "string"
          },
          "cp_name_cart": {
            "type": "string"
          },
          "rp_name_cart": {
            "type": "string"
          },
          "cp_pic_url": {
            "type": "string"
          },
          "rp_pic_url": {
            "type": "string"
          },
          "item_quantity": {
            "type": "integer"
          },
          "replacement_cost_value": {
            "type": "number",
            "multipleOf": 0.01
          },
          "date_damage": {
            "type": "string",
            "format": "date",
            "description": "The date of the submitted damage for this product."
          },
          "date_purchase": {
            "type": "string",
            "format": "date",
            "description": "The date of purchase as reported by the claimant."
          },
          "claimed_amount": {
            "type": "number",
            "multipleOf": 0.01,
            "description": "The claimed amount for the appraisal reported by the claimant."
          },
          "rp_price_date": {
            "type": "string"
          },
          "homepage_client_category_id": {
            "type": "integer"
          },
          "selected_client_category_id": {
            "type": "integer"
          },
          "shop_name": {
            "type": "string"
          },
          "shop_url": {
            "type": "string"
          },
          "is_acv_cp_price_estimate_based": {
            "type": "boolean",
            "deprecated": true,
            "description": "Use 'is_compensation_based_on_claimed_amount' instead. This field will be removed in a future version."
          },
          "is_compensation_based_on_claimed_amount": {
            "type": "boolean",
            "description": "Base the ACV calculation on the value from `claimed_amount` (Purchase Price / Repair) instead of Replacement Cost."
          },
          "depr_extra_one_year_no_receipt": {
            "type": "boolean"
          },
          "offer_id": {
            "type": "integer"
          },
          "appraisal_status_id": {
            "type": "integer",
            "description": "The ID of the assigned appraisal status."
          },
          "attachments": {
            "type": "array",
            "description": "Accessible through attachments parameter.",
            "items": {
              "$ref": "#/components/schemas/AppraisalAttachments"
            }
          }
        }
      },
      "AppraisalAttachments": {
        "type": "object",
        "properties": {
          "file_name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "update_time": {
            "type": "string"
          }
        }
      },
      "CustomerPortalLink": {
        "type": "object",
        "properties": {
          "client_category_id": {
            "type": "integer"
          },
          "client_reference": {
            "type": "string"
          },
          "link": {
            "type": "string"
          },
          "access_pin": {
            "type": "string"
          },
          "link_status": {
            "type": "string",
            "enum": ["active", "submitted", "locked"]
          }
        }
      },
      "SendAppraisalsToCustomerPortalResponse": {
        "anyOf": [
          {
            "type": "object",
            "properties": {}
          },
          {
            "type": "object",
            "properties": {
              "client_reference_id": {
                "type": "integer"
              },
              "sent_results": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "pid": {
                      "type": "integer"
                    },
                    "display_id": {
                      "type": "integer"
                    },
                    "row_id": {
                      "type": "integer"
                    },
                    "location_id": {
                      "type": "integer"
                    },
                    "location": {
                      "type": "string"
                    },
                    "quantity": {
                      "type": "number",
                      "multipleOf": 0.01
                    },
                    "description": {
                      "type": "string"
                    },
                    "condition": {
                      "type": "integer"
                    },
                    "cost": {
                      "type": "number",
                      "multipleOf": 0.01
                    },
                    "age": {
                      "type": "string"
                    },
                    "notes": {
                      "type": "string"
                    },
                    "files": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      },
                      "description": "The files key will be renamed to attachments in line with the ValueChecker API nomenclature."
                    },
                    "create_time": {
                      "type": "string"
                    },
                    "update_time": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        ]
      },
      "GroupEnum": {
        "type": "string",
        "enum": ["low", "medium", "high"]
      },
      "RecommendedOfferType": {
        "type": "string",
        "enum": ["indexed_product", "clustered_product", "product_offer"]
      },
      "CuratedSpec": {
        "type": "object",
        "properties": {
          "spec_id": {
            "type": "integer"
          },
          "spec_name": {
            "type": "string"
          },
          "spec_value_display": {
            "type": "string"
          },
          "spec_value_numeric": {
            "type": "number"
          }
        }
      },
      "CuratedShop": {
        "type": "object",
        "properties": {
          "shop_name": {
            "type": "string"
          },
          "shop_status": {
            "type": "integer"
          },
          "shop_score": {
            "type": "integer"
          }
        }
      },
      "CuratedPrice": {
        "type": "object",
        "properties": {
          "currency": {
            "type": "string"
          },
          "price": {
            "type": "number",
            "multipleOf": 0.01
          },
          "price_date": {
            "type": "string"
          },
          "is_refurbished": {
            "type": "boolean"
          },
          "in_stock": {
            "type": "boolean"
          },
          "blocked": {
            "type": "boolean"
          },
          "shop": {
            "$ref": "#/components/schemas/CuratedShop"
          },
          "item_quantity": {
            "type": "number"
          },
          "country_code": {
            "type": "string"
          },
          "filtered_price": {
            "type": "boolean"
          }
        }
      },
      "CuratedClaimedProduct": {
        "type": "object",
        "properties": {
          "pid": {
            "type": "integer"
          },
          "product_name": {
            "type": "string"
          },
          "brand": {
            "type": "string"
          },
          "pic_url": {
            "type": "string"
          },
          "specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedSpec"
            }
          },
          "client_category_id": {
            "type": "integer"
          },
          "client_category": {
            "type": "string"
          },
          "in_stock": {
            "type": "boolean"
          }
        }
      },
      "CuratedOffer": {
        "type": "object",
        "properties": {
          "pid": {
            "type": "integer"
          },
          "product_name": {
            "type": "string"
          },
          "brand": {
            "type": "string"
          },
          "pic_url": {
            "type": "string"
          },
          "specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedSpec"
            }
          },
          "client_category_id": {
            "type": "integer"
          },
          "client_category": {
            "type": "string"
          },
          "offer_id": {
            "type": "integer",
            "nullable": true
          },
          "offer_url": {
            "type": "string"
          },
          "master_name": {
            "type": "string"
          },
          "unmatched_specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedSpec"
            }
          },
          "price": {
            "$ref": "#/components/schemas/CuratedPrice"
          }
        }
      },
      "CuratedRecommendedOffer": {
        "type": "object",
        "properties": {
          "offer_type": {
            "$ref": "#/components/schemas/RecommendedOfferType"
          },
          "pid": {
            "type": "integer"
          },
          "product_name": {
            "type": "string"
          },
          "brand": {
            "type": "string"
          },
          "pic_url": {
            "type": "string"
          },
          "specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedSpec"
            }
          },
          "client_category_id": {
            "type": "integer"
          },
          "client_category": {
            "type": "string"
          },
          "offer_id": {
            "type": "integer",
            "nullable": true
          },
          "offer_url": {
            "type": "string"
          },
          "master_name": {
            "type": "string"
          },
          "unmatched_specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedSpec"
            }
          },
          "price": {
            "$ref": "#/components/schemas/CuratedPrice"
          }
        }
      },
      "CuratedPriceCluster": {
        "type": "object",
        "properties": {
          "group": {
            "$ref": "#/components/schemas/GroupEnum"
          },
          "price": {
            "type": "number",
            "multipleOf": 0.01
          },
          "count": {
            "type": "integer"
          },
          "percentage": {
            "type": "number"
          },
          "price_min": {
            "type": "number",
            "multipleOf": 0.01
          },
          "price_max": {
            "type": "number",
            "multipleOf": 0.01
          }
        }
      },
      "CuratedPriceClusters": {
        "type": "object",
        "properties": {
          "low": {
            "$ref": "#/components/schemas/CuratedPriceCluster"
          },
          "medium": {
            "$ref": "#/components/schemas/CuratedPriceCluster"
          },
          "high": {
            "$ref": "#/components/schemas/CuratedPriceCluster"
          }
        }
      },
      "CuratedClusteredProduct": {
        "type": "object",
        "properties": {
          "pid": {
            "type": "integer"
          },
          "product_name": {
            "type": "string"
          },
          "brand": {
            "type": "string"
          },
          "pic_url": {
            "type": "string"
          },
          "specs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedSpec"
            }
          },
          "client_category_id": {
            "type": "integer"
          },
          "client_category": {
            "type": "string"
          },
          "price_clusters": {
            "nullable": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/CuratedPriceClusters"
              }
            ]
          }
        }
      },
      "CuratedClusteredProducts": {
        "type": "object",
        "properties": {
          "products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedClusteredProduct"
            }
          }
        }
      },
      "IndexedPriceCluster": {
        "type": "object",
        "properties": {
          "group": {
            "$ref": "#/components/schemas/GroupEnum"
          },
          "price": {
            "type": "number",
            "multipleOf": 0.01
          }
        }
      },
      "CuratedIndexedPriceCluster": {
        "type": "object",
        "properties": {
          "low": {
            "$ref": "#/components/schemas/IndexedPriceCluster"
          },
          "medium": {
            "$ref": "#/components/schemas/IndexedPriceCluster"
          },
          "high": {
            "$ref": "#/components/schemas/IndexedPriceCluster"
          }
        }
      },
      "CuratedIndexedProduct": {
        "type": "object",
        "properties": {
          "product_name": {
            "type": "string"
          },
          "pid": {
            "type": "integer"
          },
          "pic_url": {
            "type": "string"
          },
          "price_clusters": {
            "$ref": "#/components/schemas/CuratedIndexedPriceCluster"
          }
        }
      },
      "CuratedIndexedProducts": {
        "type": "object",
        "properties": {
          "products": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedIndexedProduct"
            }
          }
        }
      },
      "CuratedGroupMetadata": {
        "type": "object",
        "properties": {
          "offer_count": {
            "type": "integer"
          }
        }
      },
      "CuratedOfferGroup": {
        "type": "object",
        "properties": {
          "metadata": {
            "$ref": "#/components/schemas/CuratedGroupMetadata"
          },
          "offers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedOffer"
            }
          }
        }
      },
      "CuratedReplacementOffers": {
        "type": "object",
        "properties": {
          "offer_groups": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CuratedOfferGroup"
            }
          }
        }
      },
      "CuratedCategory": {
        "type": "object",
        "properties": {
          "predicted_client_category_id": {
            "type": "integer"
          },
          "predicted_client_category": {
            "type": "string"
          },
          "prediction_certainty": {
            "type": "number"
          }
        }
      },
      "CuratedQuery": {
        "type": "object",
        "properties": {
          "used_query": {
            "type": "string"
          },
          "original_query": {
            "type": "string",
            "nullable": true
          },
          "predicted_query": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "CuratedPriceFilters": {
        "type": "object",
        "properties": {
          "price_min": {
            "type": "number",
            "multipleOf": 0.01,
            "nullable": true
          },
          "price_max": {
            "type": "number",
            "multipleOf": 0.01,
            "nullable": true
          }
        }
      },
      "CuratedMetadata": {
        "type": "object",
        "properties": {
          "category": {
            "$ref": "#/components/schemas/CuratedCategory"
          },
          "query": {
            "$ref": "#/components/schemas/CuratedQuery"
          },
          "price_filters": {
            "$ref": "#/components/schemas/CuratedPriceFilters"
          }
        }
      },
      "CuratedResponse": {
        "type": "object",
        "properties": {
          "claimed_product": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CuratedClaimedProduct"
              },
              {
                "type": "object",
                "properties": {},
                "example": {}
              }
            ],
            "description": "The claimed product built from the search query/image. An empty object when no claimed product could be determined."
          },
          "recommended_offer": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CuratedRecommendedOffer"
              },
              {
                "type": "object",
                "properties": {},
                "example": {}
              }
            ],
            "description": "The single ValueChecker-recommended offer/price for the search. An empty object when no recommendation could be made."
          },
          "indexed_products": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CuratedIndexedProducts"
              },
              {
                "type": "object",
                "properties": {},
                "example": {
                  "products": []
                }
              }
            ]
          },
          "clustered_products": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CuratedClusteredProducts"
              },
              {
                "type": "object",
                "properties": {},
                "example": {
                  "products": []
                }
              }
            ]
          },
          "replacement_offers": {
            "anyOf": [
              {
                "$ref": "#/components/schemas/CuratedReplacementOffers"
              },
              {
                "type": "object",
                "properties": {},
                "example": {
                  "offer_groups": []
                }
              }
            ]
          },
          "metadata": {
            "$ref": "#/components/schemas/CuratedMetadata"
          }
        }
      },
      "ForensicsRegion": {
        "type": "object",
        "description": "A bounding box around a detected edit. Coordinates are normalized to the [0, 1] range, relative to the image's width and height.",
        "properties": {
          "x_min": {
            "type": "number"
          },
          "y_min": {
            "type": "number"
          },
          "x_max": {
            "type": "number"
          },
          "y_max": {
            "type": "number"
          }
        }
      },
      "ForensicsResult": {
        "type": "object",
        "description": "The forensics status and verdicts for a single analyzed attachment.",
        "properties": {
          "row_id": {
            "type": "integer",
            "description": "Identifier of the claimed item the attachment belongs to. Results are stored per claimed item, so appraisals created from the same item share these verdicts."
          },
          "file_name": {
            "type": "string",
            "description": "The attachment file name, as returned in the appraisal's `attachments` array. Use this value when clearing a verdict."
          },
          "status": {
            "type": "string",
            "enum": ["not_started", "ongoing", "complete", "failed"],
            "description": "Per-attachment analysis lifecycle. Only `complete` carries a verdict."
          },
          "is_ai_generated": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether the image was judged AI-generated. `null` until the analysis is `complete`."
          },
          "is_digitally_manipulated": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether the image was judged digitally manipulated. `null` until the analysis is `complete`."
          },
          "ai_generated_confidence": {
            "type": "number",
            "nullable": true,
            "description": "Confidence (0-1) of the AI-generated verdict."
          },
          "manipulation_confidence": {
            "type": "number",
            "nullable": true,
            "description": "Confidence (0-1) of the manipulation verdict."
          },
          "confidence": {
            "type": "number",
            "nullable": true,
            "description": "The higher of the two per-verdict confidences, for consumers that expect one overall score. Prefer the per-verdict fields."
          },
          "analysis": {
            "type": "string",
            "nullable": true,
            "description": "Free-text explanation of the verdicts."
          },
          "regions": {
            "type": "array",
            "nullable": true,
            "description": "Bounding boxes of the detected edits, when the manipulation is localized. `null` otherwise.",
            "items": {
              "$ref": "#/components/schemas/ForensicsRegion"
            }
          },
          "flagged": {
            "type": "boolean",
            "description": "True when a completed verdict was confident enough to mark the image as flagged."
          },
          "update_time": {
            "type": "string",
            "format": "date-time",
            "description": "When the attachment's verdicts were last updated (ISO 8601)."
          }
        }
      }
    }
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "paths": {
    "/clients": {
      "get": {
        "tags": ["Account"],
        "summary": "Get Client Information",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:03:35 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "85"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "945ccee0-a255-403b-9a32-863a5f2f2c6a"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "client_id": {
                        "type": "integer"
                      },
                      "client_name": {
                        "type": "string"
                      },
                      "country_code": {
                        "type": "string"
                      },
                      "language": {
                        "type": "string"
                      }
                    }
                  }
                },
                "example": [
                  {
                    "client_id": 11,
                    "client_name": "Demo UK",
                    "country_code": "uk",
                    "language": "en"
                  }
                ]
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      }
    },
    "/client_categories": {
      "get": {
        "tags": ["Account"],
        "summary": "List Client Categories",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:06:13 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "9449"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "45d2892d-2af4-4b0e-9c68-e4bb2fec97de"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "client_category_id": {
                        "type": "integer",
                        "description": "This is an identifier used to help group and categorize the millions of consumer products in our database. It will be used as a request parameter in several of our API calls."
                      },
                      "client_category": {
                        "type": "string",
                        "description": "This is the display name for each product category."
                      },
                      "parent_client_category_id": {
                        "type": "integer"
                      },
                      "is_group_category": {
                        "type": "boolean"
                      },
                      "cid": {
                        "type": "integer",
                        "description": "The cid is the identifier that matches the `client_category_id` to ValueChecker’s internal product categories. This value is for reference only and can be ignored."
                      },
                      "category": {
                        "type": "string"
                      },
                      "api_sort_order": {
                        "type": "integer"
                      },
                      "has_depreciation": {
                        "type": "boolean"
                      },
                      "has_replacement": {
                        "type": "boolean",
                        "description": "Shows whether the `client_category_id` is considered a “Replacement category” by ValueChecker. “Replacement Categories” represent product groupings that ValueChecker has defined Like-Kind-and-Quality replacement logic for -- which means a comprehensive search to find relevant Replacement Products based on objective specification values can be completed for products in these categories. All `client_category_id’s` where `has_replacement` = True are considered “Replacement Categories”. Where `has_replacement` = False, ValueChecker is still able to search for the product and find real-time pricing information; however, there is no ability to search for Replacement Products within these categories."
                      },
                      "acv_disabled": {
                        "type": "boolean",
                        "description": "Informs as to whether the category has depreciation calculations associated with it. Depreciation can be applied in the Calculate ACV call."
                      },
                      "show_closest_matches": {
                        "type": "boolean"
                      }
                    }
                  }
                },
                "example": [
                  {
                    "client_category_id": 30893,
                    "client_category": "Undefined",
                    "parent_client_category_id": 0,
                    "is_group_category": false,
                    "cid": 0,
                    "category": "Undefined",
                    "api_sort_order": 0,
                    "has_depreciation": false,
                    "has_replacement": false,
                    "acv_disabled": true,
                    "show_closest_matches": true
                  },
                  {
                    "client_category_id": 2740,
                    "client_category": "Mobile Phones",
                    "parent_client_category_id": 0,
                    "is_group_category": false,
                    "cid": 4364,
                    "category": "Cell Phones",
                    "api_sort_order": 1,
                    "has_depreciation": true,
                    "has_replacement": true,
                    "acv_disabled": false,
                    "show_closest_matches": true
                  }
                ]
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      }
    },
    "/client_reference": {
      "post": {
        "tags": ["Client References"],
        "summary": "Create Client Reference",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "client_reference": {
                    "type": "string",
                    "description": "This must be unique to your client, otherwise we return an error. The response will contain the client_reference_id which is used in later calls."
                  },
                  "date_damage": {
                    "type": "string",
                    "description": "Date of damage in YYYY-MM-DD format. This date cannot be greater than today."
                  }
                },
                "required": ["client_reference"]
              },
              "example": {
                "client_reference": "Reference 321",
                "date_damage": "2025-11-13"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:10:05 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "66"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "93bb1e26-0d81-4d82-8ada-f40b10eabb50"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "client_reference_id": {
                      "type": "integer"
                    },
                    "client_reference": {
                      "type": "string"
                    },
                    "client_id": {
                      "type": "integer",
                      "description": "The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional."
                    },
                    "session-id": {
                      "type": "string",
                      "description": "Optional session identifier of the user."
                    }
                  }
                },
                "example": {
                  "client_reference_id": 9337,
                  "client_reference": "Reference 321"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Missing parameter",
                  "description": "The \"client_reference\" parameter is required.",
                  "event_code": "ERMPCR",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Missing parameter",
                    "description": "The client_reference parameter is required."
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      },
      "get": {
        "tags": ["Client References"],
        "summary": "List Client References",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/client_reference_name"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "Response varies based on parameters: single object for `name` parameter; array of objects otherwise.",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:11:47 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": 179
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "e4a2a557-4d7e-484d-b422-bdbaf32ca397"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "oneOf": [
                    {
                      "title": "Regular Response",
                      "type": "array",
                      "description": "Returns an array of all client reference objects.",
                      "items": {
                        "type": "object",
                        "properties": {
                          "client_reference_id": {
                            "type": "integer"
                          },
                          "client_reference": {
                            "type": "string"
                          },
                          "create_time": {
                            "type": "string"
                          },
                          "update_time": {
                            "type": "string"
                          },
                          "user_id": {
                            "type": "integer"
                          },
                          "client_id": {
                            "type": "integer"
                          }
                        }
                      }
                    },
                    {
                      "title": "Single Client Reference with name parameter",
                      "type": "object",
                      "description": "**Note:** This single-object response only occurs when the `name` query parameter is provided.",
                      "properties": {
                        "client_reference_id": {
                          "type": "integer"
                        },
                        "client_reference": {
                          "type": "string"
                        },
                        "create_time": {
                          "type": "string"
                        },
                        "update_time": {
                          "type": "string"
                        },
                        "user_id": {
                          "type": "integer"
                        },
                        "client_id": {
                          "type": "integer"
                        }
                      }
                    }
                  ]
                },
                "examples": {
                  "Standard Response": {
                    "value": [
                      {
                        "client_reference_id": 9337,
                        "client_reference": "Reference 321",
                        "create_time": "2023-07-25T11:11:05Z",
                        "update_time": "2023-07-25T11:11:05Z",
                        "user_id": 16459,
                        "client_id": 11
                      },
                      {
                        "client_reference_id": 9338,
                        "client_reference": "Reference 322",
                        "create_time": "2023-07-25 11:10:05",
                        "update_time": "2023-07-25 11:10:05",
                        "user_id": 16460,
                        "client_id": 11
                      }
                    ]
                  },
                  "Name parameter response": {
                    "value": {
                      "client_reference_id": 9337,
                      "client_reference": "Reference 321",
                      "create_time": "2023-07-25 11:10:05",
                      "update_time": "2023-07-25 11:10:05",
                      "user_id": 16459,
                      "client_id": 11
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      }
    },
    "/client_reference/{client_reference_id}": {
      "get": {
        "tags": ["Client References"],
        "summary": "Get Client Reference",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 10:33:35 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "177"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "07b2ea33-1002-44d6-adec-0e8d23b14a87"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "client_reference_id": {
                      "type": "integer"
                    },
                    "client_reference": {
                      "type": "string"
                    },
                    "user_id": {
                      "type": "integer"
                    },
                    "client_id": {
                      "type": "integer"
                    },
                    "create_time": {
                      "type": "string"
                    },
                    "update_time": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "client_reference_id": 9337,
                  "client_reference": "Reference 321",
                  "user_id": 16459,
                  "client_id": 11,
                  "create_time": "2023-07-25 11:10:05",
                  "update_time": "2023-07-25 11:10:05"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 14418 was not found",
                  "event_code": "ERNFCR",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"client_reference_id\" value",
                    "description": "The \"client_reference_id\" \"14418\" was not found"
                  }
                }
              }
            }
          }
        }
      }
    },
"/search_suggestion": {
      "get": {
        "tags": ["Product Search"],
        "summary": "Search Claimed Products (Quick)",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "{{query}}",
            "description": "User-input string. The **user** should enter the name of the product being claimed / searched for."
          },
          {
            "name": "client_category",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "{{client_category}}",
            "description": "Optional category selected or defined by the **user**."
          },
          {
            "name": "client_category_id",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "{{client_category_id}}",
            "description": "Optional correlating ID of the category selected by the **user**."
          },
          {
            "name": "force_client_category",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "example": true,
            "description": "Optional flag to force the use of the requested category."
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 10:34:22 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "20567"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "32b26779-c508-42fe-b084-abc52c7c789e"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/SearchSuggestionProduct"
                      }
                    },
                    "query": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "results": [
                    {
                      "product_name": "Apple iPhone 14 128GB (2022)",
                      "pic_url": "https://img.valuechecker.net/,---.jpg",
                      "product_pic_url": "https://img.valuechecker.net/,---.jpg",
                      "pid": 1262830543,
                      "cid": 4364,
                      "specs": [
                        {
                          "spec_id": 999,
                          "spec_value": "36",
                          "spec_value_display": "Apple",
                          "spec_value_numeric": 3,
                          "spec_name": "brand",
                          "spec_name_display": "Brand"
                        },
                        {
                          "spec_id": 1580,
                          "spec_value": "15.494",
                          "spec_value_display": "6.1\"",
                          "spec_value_numeric": 15.49,
                          "spec_name": "",
                          "spec_name_display": "Foldable Screen"
                        },
                        {
                          "spec_id": 8300,
                          "spec_value": "2022-07-01",
                          "spec_value_display": "2022",
                          "spec_value_numeric": 1656633600,
                          "spec_name": "release date",
                          "spec_name_display": "Release Year"
                        },
                        {
                          "spec_id": 8000,
                          "spec_value": "128000",
                          "spec_value_display": "128 GB",
                          "spec_value_numeric": 128000,
                          "spec_name": "size internal drive",
                          "spec_name_display": "Storage Capacity"
                        },
                        {
                          "spec_id": 5000,
                          "spec_value": "15.494",
                          "spec_value_display": "6.1\"",
                          "spec_value_numeric": 15.49,
                          "spec_name": "screen size",
                          "spec_name_display": "Screen Size"
                        }
                      ],
                      "price": {
                        "price_min": 850,
                        "price_max": 850,
                        "shop_count": 10,
                        "price_date": "2022-09-11 20:40:16"
                      }
                    },
                    {
                      "product_name": "Apple iPhone 14 Plus 128GB (2022)",
                      "pic_url": "https://img.valuechecker.net/,---.jpg",
                      "product_pic_url": "https://img.valuechecker.net/,---.jpg",
                      "pid": 1262830545,
                      "cid": 4364,
                      "specs": [
                        {
                          "spec_id": 999,
                          "spec_value": "36",
                          "spec_value_display": "Apple",
                          "spec_value_numeric": 3,
                          "spec_name": "brand",
                          "spec_name_display": "Brand"
                        },
                        {
                          "spec_id": 1580,
                          "spec_value": "No",
                          "spec_value_display": "",
                          "spec_value_numeric": 0,
                          "spec_name": "",
                          "spec_name_display": "Foldable Screen"
                        },
                        {
                          "spec_id": 8300,
                          "spec_value": "2022-07-01",
                          "spec_value_display": "2022",
                          "spec_value_numeric": 1656633600,
                          "spec_name": "release date",
                          "spec_name_display": "Release Year"
                        },
                        {
                          "spec_id": 8000,
                          "spec_value": "128000",
                          "spec_value_display": "128 GB",
                          "spec_value_numeric": 128000,
                          "spec_name": "size internal drive",
                          "spec_name_display": "Storage Capacity"
                        },
                        {
                          "spec_id": 5000,
                          "spec_value": "17.018",
                          "spec_value_display": "6.7\"",
                          "spec_value_numeric": 17.02,
                          "spec_name": "screen size",
                          "spec_name_display": "Screen Size"
                        }
                      ],
                      "price": {
                        "price_min": 700,
                        "price_max": 1200,
                        "shop_count": 134,
                        "price_date": "2023-07-20 03:41:22"
                      }
                    }
                  ],
                  "query": "iphone 14"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "error": "Missing parameter",
                  "description": "The \"query\" parameter is required."
                }
              }
            }
          }
        }
      }
    },
    "/product_search": {
      "get": {
        "tags": ["Product Search"],
        "summary": "Search Claimed Products (Extended)",
        "parameters": [
          {
            "name": "query",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "{{query}}",
            "description": "User-input string. The **user** should enter the name of the product being claimed / searched for."
          },
          {
            "name": "client_category_id",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "{{client_category_id}}",
            "description": "Optional correlating ID of the category selected by the **user**."
          },
          {
            "name": "client_category",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "{{client_category}}",
            "description": "Optional category selected or defined by the **user**."
          },
          {
            "name": "force_client_category",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "example": true,
            "description": "Optional flag to force the use of the requested category."
          },
          {
            "name": "claimed_amount",
            "in": "query",
            "schema": {
              "type": "number"
            },
            "example": 800.0,
            "description": "Optional claimed amount for the product."
          },
          {
            "name": "price_min",
            "in": "query",
            "schema": {
              "type": "number"
            },
            "example": 10.0,
            "description": "Optional minimum price limit for the search."
          },
          {
            "name": "price_max",
            "in": "query",
            "schema": {
              "type": "number"
            },
            "example": 1000.0,
            "description": "Optional maximum price limit for the search."
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 10:35:35 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "16972"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "5823ed94-af9a-427d-b9e3-08f8bc70702f"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/SearchProduct"
                      }
                    },
                    "metadata": {
                      "$ref": "#/components/schemas/SearchProductMetadata"
                    }
                  }
                },
                "example": {
                  "results": [
                    {
                      "pid": 1262830543,
                      "client_category_id": 4364,
                      "client_category": "Cell Phones",
                      "product_name": "Apple iPhone 14 128GB (2022)",
                      "pic_url": "https://img.valuechecker.net/,---.jpg",
                      "product_picture_url": "https://img.valuechecker.net/,---.jpg",
                      "specs": [
                        {
                          "spec_id": 999,
                          "spec_value": "36",
                          "spec_value_display": "Apple",
                          "spec_value_numeric": 3,
                          "spec_name": "Brand",
                          "spec_name_display": "Brand"
                        },
                        {
                          "spec_id": 1580,
                          "spec_value": "15.494",
                          "spec_value_display": "6.1\"",
                          "spec_value_numeric": 15.49,
                          "spec_name": "Foldable Screen",
                          "spec_name_display": "Foldable Screen"
                        },
                        {
                          "spec_id": 8300,
                          "spec_value": "2022-07-01",
                          "spec_value_display": "2022",
                          "spec_value_numeric": 1656633600,
                          "spec_name": "Release Year",
                          "spec_name_display": "Release Year"
                        },
                        {
                          "spec_id": 8000,
                          "spec_value": "128000",
                          "spec_value_display": "128 GB",
                          "spec_value_numeric": 128000,
                          "spec_name": "Storage Capacity",
                          "spec_name_display": "Storage Capacity"
                        },
                        {
                          "spec_id": 5000,
                          "spec_value": "15.494",
                          "spec_value_display": "6.1\"",
                          "spec_value_numeric": 15.49,
                          "spec_name": "Screen Size",
                          "spec_name_display": "Screen Size"
                        }
                      ],
                      "price": {
                        "price_min": 850,
                        "price_max": 850,
                        "shop_count": 10,
                        "price_date": "2022-09-11 20:40:16"
                      },
                      "PriceClusters": {
                        "low": {
                          "udc_id": 369929,
                          "pid": 1941916191,
                          "group": "low",
                          "price": 147,
                          "count": 31,
                          "percentage": 0.76,
                          "min_price": 19,
                          "max_price": 364
                        },
                        "medium": {
                          "udc_id": 369930,
                          "pid": 1941916191,
                          "group": "medium",
                          "price": 158,
                          "count": 41,
                          "percentage": 1,
                          "min_price": 19,
                          "max_price": 1619
                        },
                        "high": {
                          "udc_id": 369931,
                          "pid": 1941916191,
                          "group": "high",
                          "price": 1491,
                          "count": 5,
                          "percentage": 0.12,
                          "min_price": 1289,
                          "max_price": 1619
                        }
                      },
                      "child_products": [
                        "Apple iPhone 14 Plus 128GB (PRODUCT)RED",
                        "Apple iPhone 14 Plus 128GB (PRODUCT)RED Special Edition"
                      ],
                      "child_product_contents": []
                    },
                    {
                      "pid": 1262830545,
                      "client_category_id": 4364,
                      "client_category": "Cell Phones",
                      "product_name": "Apple iPhone 14 Plus 128GB (2022)",
                      "product_picture_url": "https://img.valuechecker.net/,---.jpg",
                      "specs": [
                        {
                          "spec_id": 999,
                          "spec_value": "36",
                          "spec_value_display": "Apple",
                          "spec_value_numeric": 3,
                          "spec_name": "Brand",
                          "spec_name_display": "Brand"
                        },
                        {
                          "spec_id": 8300,
                          "spec_value": "2022-07-01",
                          "spec_value_display": "2022",
                          "spec_value_numeric": 1656633600,
                          "spec_name": "Release Year",
                          "spec_name_display": "Release Year"
                        },
                        {
                          "spec_id": 8000,
                          "spec_value": "128000",
                          "spec_value_display": "128 GB",
                          "spec_value_numeric": 128000,
                          "spec_name": "Storage Capacity",
                          "spec_name_display": "Storage Capacity"
                        },
                        {
                          "spec_id": 5000,
                          "spec_value": "17.018",
                          "spec_value_display": "6.7\"",
                          "spec_value_numeric": 17.02,
                          "spec_name": "Screen Size",
                          "spec_name_display": "Screen Size"
                        }
                      ],
                      "price": {
                        "price_min": 700,
                        "price_max": 1200,
                        "shop_count": 134,
                        "price_date": "2023-07-20 03:41:22"
                      },
                      "child_products": [],
                      "child_product_contents": []
                    }
                  ],
                  "metadata": {
                    "used_query": "iphone 14",
                    "category": {
                      "requested_client_category_id": 2740,
                      "requested_client_category": "Mobile Phones",
                      "predicted_client_category_id": 2740,
                      "predicted_client_category": "Mobile Phones",
                      "prediction_certainty": 1.0,
                      "category_switched": false
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "error": "Missing parameter",
                  "description": "The \"query\" parameter is required."
                }
              }
            }
          }
        }
      }
    },
    "/prices": {
      "get": {
        "tags": ["Product Search"],
        "summary": "Get Replacement Products",
        "parameters": [
          {
            "name": "pid",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "1262828314",
            "description": "The product identifier (usually selected from the product search response)."
          },
          {
            "name": "country",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "{{country}}",
            "description": "The country in where prices will be searched."
          },
          {
            "name": "client_category",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "{{client_category}}"
          },
          {
            "name": "client_category_id",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "example": "{{client_category_id}}"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 11:48:58 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "330017"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "5f6962fe-5c32-4d8d-ad17-0bca391b0c19"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "claimed_product": {
                      "$ref": "#/components/schemas/ClaimedProduct"
                    },
                    "grouped_prices": {
                      "type": "array",
                      "description": "!! Group consists of an array of arrays containing price objects. Check the example for more details.",
                      "items": {
                        "$ref": "#/components/schemas/PriceListElement"
                      }
                    }
                  }
                },
                "example": {
                  "claimed_product": {
                    "pid": 1262828314,
                    "master_name": "",
                    "product_name": "Apple iPhone 14 Pro Max 1TB",
                    "vcid": 1417514,
                    "cid": 4364,
                    "pic_url": "https://img.valuechecker.net/,---.jpg",
                    "product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
                    "product_url": "https://www.pricerunner.com/pl/1-3202448228/Mobile-Phones/Apple-iPhone-14-Pro-Max-1TB-Compare-Prices",
                    "specs": [
                      {
                        "spec_id": 888,
                        "spec_value": "Pro",
                        "spec_value_display": "Pro",
                        "spec_value_numeric": 2,
                        "spec_name_display": "Model Family"
                      },
                      {
                        "spec_id": 999,
                        "spec_value": "36",
                        "spec_value_display": "Apple",
                        "spec_value_numeric": 3,
                        "spec_name_display": "Brand"
                      },
                      {
                        "spec_id": 8300,
                        "spec_value": "2022-07-01",
                        "spec_value_display": "2022",
                        "spec_value_numeric": 1656633600,
                        "spec_name_display": "Release Year"
                      },
                      {
                        "spec_id": 8000,
                        "spec_value": "1000000",
                        "spec_value_display": "1024 GB",
                        "spec_value_numeric": 1000000,
                        "spec_name_display": "Storage Capacity"
                      },
                      {
                        "spec_id": 5000,
                        "spec_value": "17.018",
                        "spec_value_display": "6.7\"",
                        "spec_value_numeric": 17.02,
                        "spec_name_display": "Screen Size"
                      }
                    ],
                    "in_stock": true,
                    "query_at_limit": false,
                    "client_category_id": 4364,
                    "client_category": "Mobile Phones"
                  },
                  "grouped_prices": [
                    [
                      {
                        "shop_product_name": "Apple iPhone 14 Pro Max (1 TB) - Gold",
                        "currency": "GBP",
                        "total_price": 1684.99,
                        "base_price": 1684.99,
                        "price_date": "2023-07-25 11:07:41",
                        "offer_id": 228246862,
                        "offer_url": "https://offer.valuechecker.net/abc---123",
                        "international": false,
                        "is_refurbished": false,
                        "in_stock": true,
                        "blocked": false,
                        "country_code": "uk",
                        "product": {
                          "pid": 1263096838,
                          "sid": 44001,
                          "vcid": 1417514,
                          "source_internal_id": "3202448228",
                          "master_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "product_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "master_pic_url": "https://img.valuechecker.net/200x,---.jpg",
                          "pic_url": "https://img.valuechecker.net/,---.jpg",
                          "product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
                          "product_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
                          "brand": "Apple",
                          "price": {
                            "price_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf"
                          },
                          "rp_first_choice": true,
                          "specs": [
                            {
                              "spec_id": 888,
                              "spec_value_display": "Pro",
                              "spec_value_numeric": 2,
                              "spec_name_display": "Model Family"
                            },
                            {
                              "spec_id": 999,
                              "spec_value_display": "Apple",
                              "spec_value_numeric": 3,
                              "spec_name_display": "Brand"
                            },
                            {
                              "spec_id": 8300,
                              "spec_value_display": "2022",
                              "spec_value_numeric": 1656633600,
                              "spec_name_display": "Release Year"
                            },
                            {
                              "spec_id": 8000,
                              "spec_value_display": "1024 GB",
                              "spec_value_numeric": 1000000,
                              "spec_name_display": "Storage Capacity"
                            },
                            {
                              "spec_id": 5000,
                              "spec_value_display": "6.7\"",
                              "spec_value_numeric": 17.02,
                              "spec_name_display": "Screen Size"
                            }
                          ],
                          "same_alid_as_cp": true,
                          "score_perfect": true,
                          "score": 12459
                        },
                        "shop": {
                          "shop_name": "Amazon UK",
                          "shop_status": 1,
                          "shop_score": 0
                        },
                        "filtered_price": false,
                        "outside_price_range": false
                      },
                      {
                        "shop_product_name": "Apple iPhone 14 Pro Max (1 TB) - Deep Purple",
                        "currency": "GBP",
                        "total_price": 1684.99,
                        "base_price": 1684.99,
                        "price_date": "2023-07-25 11:07:41",
                        "offer_id": 228246863,
                        "offer_url": "https://offer.valuechecker.net/abc---123",
                        "international": false,
                        "is_refurbished": false,
                        "in_stock": true,
                        "blocked": false,
                        "country_code": "uk",
                        "product": {
                          "pid": 1263096838,
                          "sid": 44001,
                          "vcid": 1417514,
                          "source_internal_id": "3202448228",
                          "master_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "product_name": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "master_pic_url": "https://img.valuechecker.net/200x,---.jpg",
                          "pic_url": "https://img.valuechecker.net/,---.jpg",
                          "product_pic_url": "https://img.valuechecker.net/200x,---.jpg",
                          "product_url": "https://offer-staging.valuechecker.net/dAkKadvB66xaQJoaQF5BrG",
                          "brand": "Apple",
                          "price": {
                            "price_url": "https://offer-staging.valuechecker.net/dAkKadvB66xaQJoaQF5BrG"
                          },
                          "rp_first_choice": true,
                          "specs": [
                            {
                              "spec_id": 888,
                              "spec_value_display": "Pro",
                              "spec_value_numeric": 2,
                              "spec_name_display": "Model Family"
                            },
                            {
                              "spec_id": 999,
                              "spec_value_display": "Apple",
                              "spec_value_numeric": 3,
                              "spec_name_display": "Brand"
                            },
                            {
                              "spec_id": 8300,
                              "spec_value_display": "2022",
                              "spec_value_numeric": 1656633600,
                              "spec_name_display": "Release Year"
                            },
                            {
                              "spec_id": 8000,
                              "spec_value_display": "1024 GB",
                              "spec_value_numeric": 1000000,
                              "spec_name_display": "Storage Capacity"
                            },
                            {
                              "spec_id": 5000,
                              "spec_value_display": "6.7\"",
                              "spec_value_numeric": 17.02,
                              "spec_name_display": "Screen Size"
                            }
                          ],
                          "same_alid_as_cp": true,
                          "score_perfect": true,
                          "score": 12459
                        },
                        "shop": {
                          "shop_name": "Amazon UK",
                          "shop_status": 1,
                          "shop_score": 0
                        },
                        "filtered_price": false,
                        "outside_price_range": false
                      }
                    ]
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Missing parameter",
                  "description": "The \"pid\" parameter is required.",
                  "event_code": "ERMPPR",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Missing parameter",
                    "description": "The \"pid\" parameter is required."
                  }
                }
              }
            }
          }
        }
      }
    },
        "/search/offers": {
      "post": {
        "tags": ["Product Search"],
        "summary": "Search Offers",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "query": {
                    "type": "string",
                    "description": "The product name, model number, or other identifier the customer is claiming."
                  },
                  "image_urls": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "One or more publicly reachable URLs that point to images supporting the claim."
                  },
                  "images": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "description": "One or more base‑64‑encoded image strings (use when direct URLs aren't available)."
                  },
                  "claimed_amount": {
                    "type": "number",
                    "multipleOf": 0.01,
                    "description": "The monetary amount (in the currency of record) that the customer is requesting to be reimbursed."
                  },
                  "price_min": {
                    "type": "number",
                    "multipleOf": 0.01,
                    "description": "Lower price threshold: offers priced below this value are filtered out and not returned."
                  },
                  "price_max": {
                    "type": "number",
                    "multipleOf": 0.01,
                    "description": "Upper price threshold: offers priced above this value are filtered out and not returned."
                  }
                }
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK - Returns offer search results with claimed product, recommended offer, and replacement options",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CuratedResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "error": "Invalid JSON",
                  "description": "Could not parse an empty JSON body"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "User <user> does not have access to client_id <client_id>.",
                  "event_code": "ERIP00",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Invalid parameter",
                    "description": "The \"client_id\" parameter is invalid."
                  }
                }
              }
            }
          }
        }
      }
    },
    "/client_reference/appraisal_statuses": {
      "get": {
        "tags": ["Appraisal Statuses"],
        "summary": "List Appraisal Statuses",
        "description": "Retrieve all available appraisal statuses based on client settings.",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "List of available appraisal statuses",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "appraisal_statuses": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "appraisal_status_id": {
                            "type": "integer",
                            "description": "Unique identifier for the appraisal status"
                          },
                          "enabled": {
                            "type": "boolean",
                            "description": "Indicates this status is enabled on the client."
                          },
                          "appraisal_status": {
                            "type": "string",
                            "description": "Indicates appraisal status."
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "appraisal_statuses": [
                    {
                      "appraisal_status_id": 1,
                      "appraisal_status": "Open",
                      "enabled": 1
                    },
                    {
                      "appraisal_status_id": 2,
                      "appraisal_status": "Accepted",
                      "enabled": 1
                    },
                    {
                      "appraisal_status_id": 3,
                      "appraisal_status": "Rejected",
                      "enabled": 1
                    },
                    {
                      "appraisal_status_id": 4,
                      "appraisal_status": "Closed",
                      "enabled": 1
                    },
                    {
                      "appraisal_status_id": 5,
                      "appraisal_status": "Flagged",
                      "enabled": 1
                    },
                    {
                      "appraisal_status_id": 6,
                      "appraisal_status": "Archived",
                      "enabled": 1
                    }
                  ]
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "title": "Required feature is not enabled.",
                  "description": "Please contact support to have this feature enabled."
                }
              }
            }
          }
        }
      }
    },
    "/client_references/appraisals": {
      "get": {
        "tags": ["Client References"],
        "summary": "List Client References with Appraisals",
        "description": "Get all client references with their appraisals. When `all_users=false` (the default behavior), client references for the current user only are returned. When you set `all_users=true`, client references for all users within the client_id are returned.",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          },
          {
            "name": "all_users",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "description": "When false (the default behavior), returns only client references for the current user. If set as true, returns client references for all users within client_id.",
            "example": false
          },
          {
            "name": "age_threshold",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Time range with unit suffix (e.g., '1h', '2d', '1w'). Default is '1w'.",
            "example": "1w"
          },
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 10000
            },
            "description": "Number of appraisals per page. If no page limit is defined, the default is 100. The maximum allowable limit is 10,000, and any higher value will be capped at this maximum.",
            "example": 100
          },
          {
            "name": "page_number",
            "in": "query",
            "schema": {
              "type": "integer",
              "minimum": 1
            },
            "description": "Page number for pagination. Default is 1.",
            "example": 1
          }
        ],
        "responses": {
          "200": {
            "description": "Client references with appraisals exported successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "client_id": {
                      "type": "integer",
                      "description": "The client ID."
                    },
                    "client_name": {
                      "type": "string",
                      "description": "The client name."
                    },
                    "client_references": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "client_reference_id": {
                            "type": "integer",
                            "description": "The client reference identifier."
                          },
                          "client_reference": {
                            "type": "string",
                            "description": "The client reference name."
                          },
                          "client_reference_owner": {
                            "type": "string",
                            "description": "Owner of the client reference (user who created the client reference)."
                          },
                          "client_reference_create_time": {
                            "type": "string",
                            "format": "date-time",
                            "description": "When the client reference was created."
                          },
                          "client_reference_appraisals_update_time": {
                            "type": "string",
                            "format": "date-time",
                            "description": "When the client reference appraisals were last updated."
                          },
                          "appraisals": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "properties": {
                                "appraisal_id": {
                                  "type": "integer",
                                  "description": "The appraisal identifier."
                                },
                                "client_reference_id": {
                                  "type": "integer",
                                  "description": "The client reference identifier."
                                },
                                "cpid": {
                                  "type": "integer",
                                  "description": "Claimed Product ID."
                                },
                                "rpid": {
                                  "type": "integer",
                                  "description": "Replacement Product ID."
                                },
                                "create_time": {
                                  "type": "string",
                                  "format": "date-time",
                                  "description": "When the appraisal was created."
                                },
                                "update_time": {
                                  "type": "string",
                                  "format": "date-time",
                                  "description": "When the appraisal was last updated."
                                },
                                "cp_name_cart": {
                                  "type": "string",
                                  "description": "Claimed product name in cart."
                                },
                                "rp_name_cart": {
                                  "type": "string",
                                  "description": "Replacement product name in cart."
                                },
                                "cp_pic_url": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "Claimed product picture URL."
                                },
                                "rp_pic_url": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "Replacement product picture URL."
                                },
                                "item_quantity": {
                                  "type": "number",
                                  "description": "Quantity of claimed item(s)."
                                },
                                "replacement_cost_value": {
                                  "type": "number",
                                  "nullable": true,
                                  "description": "The replacement cost value."
                                },
                                "rp_price_date": {
                                  "type": "string",
                                  "format": "date-time",
                                  "nullable": true,
                                  "description": "The replacement product price date."
                                },
                                "homepage_client_category_id": {
                                  "type": "integer",
                                  "nullable": true,
                                  "description": "Homepage client category ID."
                                },
                                "selected_client_category_id": {
                                  "type": "integer",
                                  "nullable": true,
                                  "description": "Selected client category ID."
                                },
                                "shop_id": {
                                  "type": "integer",
                                  "nullable": true,
                                  "description": "The shop ID."
                                },
                                "shop_name": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "The shop name."
                                },
                                "offer_id": {
                                  "type": "integer",
                                  "nullable": true,
                                  "description": "The offer ID."
                                },
                                "shop_url": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "The shop URL."
                                },
                                "valuation_snapshot": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "URL to permanent page hosted by ValueChecker with the origin / proof of the valuation at the time of the search. This page includes the timestamp and snapshot of the shop offer(s) that the ValueChecker valuation was based on."
                                },
                                "claimed_amount": {
                                  "type": "number",
                                  "nullable": true,
                                  "description": "The claimed amount for the appraisal reported by the claimant."
                                },
                                "actual_cash_value": {
                                  "type": "number",
                                  "nullable": true,
                                  "description": "Actual cash value of the item."
                                },
                                "is_compensation_based_on_claimed_amount": {
                                  "type": "boolean",
                                  "nullable": true,
                                  "description": "Base the ACV calculation on the value from `claimed_amount` (Purchase Price / Repair) instead of Replacement Cost"
                                },
                                "depr_extra_one_year_no_receipt": {
                                  "type": "boolean",
                                  "nullable": true,
                                  "description": "Depreciation extra one year no receipt flag."
                                },
                                "comment": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "The appraisal comment."
                                },
                                "date_damage": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "Date of damage in YYYY-MM-DD format."
                                },
                                "appraisal_condition": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "The appraisal condition."
                                },
                                "appraisal_status": {
                                  "type": "string",
                                  "nullable": true,
                                  "description": "The appraisal status."
                                },
                                "appraisal_deductible": {
                                  "type": "number",
                                  "nullable": true,
                                  "description": "The appraisal deductible."
                                },
                                "attachments": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "file_name": {
                                        "type": "string",
                                        "description": "File name of the attachment."
                                      },
                                      "url": {
                                        "type": "string",
                                        "description": "URL to the attachment."
                                      },
                                      "type": {
                                        "type": "string",
                                        "description": "Type of the attachment."
                                      },
                                      "update_time": {
                                        "type": "string",
                                        "format": "date-time",
                                        "nullable": true,
                                        "description": "When the attachment was last updated."
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "metadata": {
                      "type": "object",
                      "properties": {
                        "fetch_time": {
                          "type": "string",
                          "description": "Time when the data was fetched."
                        },
                        "x_request_id": {
                          "type": "string",
                          "description": "Request ID for tracking."
                        },
                        "current_page": {
                          "type": "integer",
                          "description": "Current page number of the paginated results."
                        },
                        "total_pages": {
                          "type": "integer",
                          "description": "Total number of pages available."
                        },
                        "total_results": {
                          "type": "integer",
                          "description": "Total number of results across all pages."
                        }
                      }
                    }
                  }
                },
                "example": {
                  "client_id": 11,
                  "client_name": "Demo UK",
                  "client_references": [
                    {
                      "client_reference_id": 9337,
                      "client_reference": "Reference 321",
                      "client_reference_owner": "user@example.com",
                      "client_reference_create_time": "2023-07-24 11:10:05",
                      "client_reference_appraisals_update_time": "2023-07-25 11:10:05",
                      "appraisals": [
                        {
                          "appraisal_id": 97771,
                          "client_reference_id": 9337,
                          "cpid": 123456,
                          "rpid": 234567,
                          "create_time": "2023-07-25 13:54:37",
                          "update_time": "2023-07-25 13:54:37",
                          "cp_name_cart": "Apple iPhone 14 Pro Max 1TB",
                          "rp_name_cart": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "cp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "rp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "item_quantity": 1,
                          "replacement_cost_value": 1684.99,
                          "rp_price_date": "2023-07-25 11:07:41",
                          "homepage_client_category_id": 2740,
                          "selected_client_category_id": 2740,
                          "shop_id": 123,
                          "shop_name": "Amazon UK",
                          "offer_id": 9876,
                          "shop_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
                          "valuation_snapshot": "https://web.valuechecker.ai/valuation/36e090ae516dfc47",
                          "claimed_amount": 600.0,
                          "actual_cash_value": 500.0,
                          "is_compensation_based_on_claimed_amount": true,
                          "depr_extra_one_year_no_receipt": false,
                          "comment": "Example comment",
                          "date_damage": "2023-07-20",
                          "appraisal_condition": "Average",
                          "appraisal_status": "Open",
                          "appraisal_deductible": 100.0,
                          "attachments": [
                            {
                              "file_name": "damage_photo.jpg",
                              "url": "https://example.com/damage_photo.jpg",
                              "type": "image",
                              "update_time": "2023-07-25T11:51:08Z"
                            }
                          ]
                        }
                      ]
                    }
                  ],
                  "metadata": {
                    "fetch_time": "2023-07-25 13:54:37",
                    "x_request_id": "93bb1e26-0d81-4d82-8ada-f40b10eabb50",
                    "appraisals": {
                      "current_page": 1,
                      "total_pages": 1,
                      "total_results": 1
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          }
        }
      }
    },
    "/client_reference/{client_reference_id}/appraisal": {
      "post": {
        "tags": ["Appraisals"],
        "summary": "Create Appraisal",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "client_id": {
                    "type": "string"
                  },
                  "session-id": {
                    "type": "string",
                    "description": "Optional session identifier of the user."
                  },
                  "client_reference_id": {
                    "type": "string"
                  },
                  "cpid": {
                    "type": "string",
                    "description": "This is the Claimed Product Identifier. You should have this value from the previous response Step 3: (RP) from field `claimed_product.pid`."
                  },
                  "rpid": {
                    "type": "string",
                    "description": "This is the Replacement Product Identifier. The previous response should have one or more Replacement Products. You should take the value from whichever product you select from field `grouped_prices.[Y].[X].pid` (where X is the numbered product of the Y numbered group)."
                  },
                  "homepage_client_category_id": {
                    "type": "integer"
                  },
                  "selected_client_category_id": {
                    "type": "integer"
                  },
                  "item_quantity": {
                    "type": "integer"
                  },
                  "is_price_per_item": {
                    "type": "boolean"
                  },
                  "rp_name_cart": {
                    "type": "string"
                  },
                  "offer_id": {
                    "type": "string"
                  },
                  "shop_name": {
                    "type": "string"
                  },
                  "shop_url": {
                    "type": "string"
                  },
                  "replacement_cost_value": {
                    "type": "number",
                    "multipleOf": 0.01,
                    "description": "This is an optional variable parameter. You can either use the price from the previous response from field `grouped_prices.[Y].[X].total_price` or you can set a custom value based on your own logic."
                  },
                  "rp_price_date": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "required": ["cpid", "rpid"]
              },
              "example": {
                "client_id": "10",
                "client_reference_id": "200",
                "cpid": "123456",
                "rpid": "234567",
                "homepage_client_category_id": 2740,
                "selected_client_category_id": 2740,
                "item_quantity": 1,
                "is_price_per_item": true,
                "rp_name_cart": "A product name",
                "offer_id": "9876",
                "shop_name": "A shop name",
                "shop_url": "https://some.shop",
                "replacement_cost_value": 300.0,
                "rp_price_date": "2021-02-17 13:36:10"
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 11:51:08 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "23"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "58704e3b-564a-4a6a-935c-26169a982829"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "appraisal_id": {
                      "type": "integer"
                    }
                  }
                },
                "example": {
                  "appraisal_id": 97771
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "cpid : field required; rpid : field required",
                  "event_code": "ERMPAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Missing parameter",
                    "description": "The \"cpid\" parameter is required."
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 14418 was not found",
                  "event_code": "ERNFAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"client_reference_id\" value",
                    "description": "The client_reference_id \"14418\" was not found"
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "tags": ["Appraisals"],
        "summary": "List Appraisals",
        "description": "This endpoint returns a paginated response. For Client References with a larger quantity of appraisals, use pagination parameters.\n\n`page` - Defaults to 1. The minimum value is 1, defaults to 1 if it's a non-positive integer.\n\n`page_size` - Defaults to 25. The minimum value is 10, and the maximum value is 100.",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/page_size"
          },
          {
            "$ref": "#/components/parameters/attachments"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 11:52:07 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "2238"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "4b4a1ee3-9217-4452-8d61-6427a195fa78"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "appraisals": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Appraisal"
                      }
                    },
                    "metadata": {
                      "$ref": "#/components/schemas/AppraisalMetadata"
                    }
                  }
                },
                "examples": {
                  "Standard response": {
                    "value": {
                      "appraisals": [
                        {
                          "appraisal_id": 97771,
                          "client_reference_id": 9337,
                          "cpid": 1262828314,
                          "rpid": 1263096838,
                          "create_time": "2023-07-25 13:51:08",
                          "update_time": "2023-07-25 13:51:08",
                          "cp_name_cart": "Apple iPhone 14 Pro Max 1TB",
                          "rp_name_cart": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "cp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "rp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "item_quantity": 1,
                          "replacement_cost_value": 1684.99,
                          "rp_price_date": "2023-07-25 11:07:41",
                          "homepage_client_category_id": 2740,
                          "selected_client_category_id": 2740,
                          "date_damage": "2024-05-07",
                          "date_purchase": "2024-05-01",
                          "claimed_amount": 1000.0,
                          "shop_name": "Amazon UK",
                          "shop_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
                          "is_compensation_based_on_claimed_amount": false,
                          "depr_extra_one_year_no_receipt": false,
                          "offer_id": 228246862
                        },
                        {
                          "appraisal_id": 97770,
                          "client_reference_id": 9337,
                          "cpid": 1262828314,
                          "rpid": 1263096838,
                          "create_time": "2023-07-25 13:50:46",
                          "update_time": "2023-07-25 13:50:46",
                          "cp_name_cart": "Apple iPhone 14 Pro Max 1TB",
                          "rp_name_cart": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "cp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "rp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "item_quantity": 1,
                          "replacement_cost_value": 1684.99,
                          "date_damage": "2024-05-07",
                          "date_purchase": "2024-05-01",
                          "claimed_amount": 1000.0,
                          "rp_price_date": "2023-07-25 11:07:41",
                          "homepage_client_category_id": 2740,
                          "selected_client_category_id": 2740,
                          "shop_name": "Amazon UK",
                          "shop_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
                          "is_compensation_based_on_claimed_amount": false,
                          "depr_extra_one_year_no_receipt": false,
                          "offer_id": 228246862
                        }
                      ],
                      "metadata": {
                        "ongoing_count": 0,
                        "timestamp": "2025-03-31 10:08:36",
                        "appraisals": {
                          "current_page": 1,
                          "page_size": 25,
                          "total_pages": 1,
                          "total_items": 2
                        }
                      }
                    }
                  },
                  "Attachments parameter response": {
                    "summary": "Appraisal not yet available",
                    "value": {
                      "appraisals": [
                        {
                          "appraisal_id": 97771,
                          "client_reference_id": 9337,
                          "cpid": 1262828314,
                          "rpid": 1263096838,
                          "create_time": "2023-07-25 13:51:08",
                          "update_time": "2023-07-25 13:51:08",
                          "cp_name_cart": "Apple iPhone 14 Pro Max 1TB",
                          "rp_name_cart": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "cp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "rp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "item_quantity": 1,
                          "replacement_cost_value": 1684.99,
                          "date_damage": "2024-05-07",
                          "date_purchase": "2024-05-01",
                          "claimed_amount": 1000.0,
                          "rp_price_date": "2023-07-25 11:07:41",
                          "homepage_client_category_id": 2740,
                          "selected_client_category_id": 2740,
                          "shop_name": "Amazon UK",
                          "shop_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
                          "is_compensation_based_on_claimed_amount": false,
                          "depr_extra_one_year_no_receipt": false,
                          "offer_id": 228246862,
                          "attachments": [
                            {
                              "file_name": "cat.gif",
                              "url": "https://storage.googleapis.com/vc/example/attachments/1/1/cat.gif",
                              "type": "image/gif",
                              "update_time": "2025-01-01 11:06:45"
                            },
                            {
                              "file_name": "logo.svg",
                              "url": "https://storage.googleapis.com/vc/example/attachments/1/2/logo.svg",
                              "type": "image/svg+xml",
                              "update_time": "2025-01-01 11:06:23"
                            }
                          ]
                        },
                        {
                          "appraisal_id": 97770,
                          "client_reference_id": 9337,
                          "cpid": 1262828314,
                          "rpid": 1263096838,
                          "create_time": "2023-07-25 13:50:46",
                          "update_time": "2023-07-25 13:50:46",
                          "cp_name_cart": "Apple iPhone 14 Pro Max 1TB",
                          "rp_name_cart": "Apple iPhone 14 Pro Max 1024GB (2022)",
                          "cp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "rp_pic_url": "https://img.valuechecker.net/,---.jpg",
                          "item_quantity": 1,
                          "replacement_cost_value": 1684.99,
                          "date_damage": "2024-05-07",
                          "date_purchase": "2024-05-01",
                          "claimed_amount": 1000.0,
                          "rp_price_date": "2023-07-25 11:07:41",
                          "homepage_client_category_id": 2740,
                          "selected_client_category_id": 2740,
                          "shop_name": "Amazon UK",
                          "shop_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
                          "is_compensation_based_on_claimed_amount": false,
                          "depr_extra_one_year_no_receipt": false,
                          "offer_id": 228246862,
                          "attachments": []
                        }
                      ],
                      "metadata": {
                        "ongoing_count": 0,
                        "timestamp": "2025-03-31 10:08:36",
                        "appraisals": {
                          "current_page": 1,
                          "page_size": 25,
                          "total_pages": 1,
                          "total_items": 2
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Appraisal id 239055 was not found",
                  "event_code": "ERNFAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"appraisal_id\" value",
                    "description": "The appraisal_id \"239055\" was not found"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": ["Appraisals"],
        "summary": "Delete All Appraisals",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 11:52:45 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "8776d644-c8ac-4134-a703-bc49b95ccc15"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {}
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 14418 was not found",
                  "event_code": "ERNFAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"client_reference_id\" value",
                    "description": "The client_reference_id \"14418\" was not found"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/client_reference/{client_reference_id}/appraisal/{appraisal_id}": {
      "get": {
        "tags": ["Appraisals"],
        "summary": "Get Appraisal",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/appraisal_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 11:54:40 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "1117"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "33fb2b11-220f-4f60-9cc8-218d34985d81"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "$ref": "#/components/schemas/Appraisal"
                },
                "example": {
                  "appraisal_id": 97773,
                  "client_reference_id": 9337,
                  "cpid": 1262828314,
                  "rpid": 1263096838,
                  "create_time": "2023-07-25 13:54:37",
                  "update_time": "2023-07-25 13:54:37",
                  "cp_name_cart": "Apple iPhone 14 Pro Max 1TB",
                  "rp_name_cart": "Apple iPhone 14 Pro Max 1024GB (2022)",
                  "cp_pic_url": "https://img.valuechecker.net/,---.jpg",
                  "rp_pic_url": "https://img.valuechecker.net/,---.jpg",
                  "item_quantity": 1,
                  "replacement_cost_value": 1684.99,
                  "date_damage": "2024-05-07",
                  "date_purchase": "2024-05-01",
                  "cp_price_estimate": 1000.0,
                  "claimed_amount": 1000.0,
                  "rp_price_date": "2023-07-25 11:07:41",
                  "homepage_client_category_id": 2740,
                  "selected_client_category_id": 2740,
                  "shop_name": "Amazon UK",
                  "shop_url": "https://offer.valuechecker.net/kihxRTjWvGNjq4Dj7CKanf",
                  "is_compensation_based_on_claimed_amount": false,
                  "depr_extra_one_year_no_receipt": false,
                  "offer_id": 228246862,
                  "appraisal_status_id": 2
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Appraisal id 239055 was not found",
                  "event_code": "ERNFAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"appraisal_id\" value",
                    "description": "The appraisal_id \"239055\" was not found"
                  }
                }
              }
            }
          }
        }
      },
      "put": {
        "tags": ["Appraisals"],
        "summary": "Update Appraisal",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "rpid": {
                    "type": "integer",
                    "description": "This is the Replacement Product Identifier. The previous response should have one or more Replacement Products. You should take the value from whichever product you select from field `grouped_prices.[Y].[X].pid` (where X is the numbered product of the Y numbered group)."
                  },
                  "cp_name_cart": {
                    "type": "string",
                    "description": "Custom name for the claimed product (the cpid cannot be changed)."
                  },
                  "rp_name_cart": {
                    "type": "string",
                    "description": "Custom name for the replacement product."
                  },
                  "rp_pic_url": {
                    "type": "string"
                  },
                  "rp_price_date": {
                    "type": "string",
                    "format": "date-time"
                  },
                  "replacement_cost_value": {
                    "type": "number",
                    "multipleOf": 0.01,
                    "description": "Modified product price."
                  },
                  "claimed_amount": {
                    "type": "number",
                    "multipleOf": 0.01,
                    "description": "The value claimed by the policyholder (Purchase Price / Repair)."
                  },
                  "offer_id": {
                    "type": "integer"
                  },
                  "shop_name": {
                    "type": "string"
                  },
                  "shop_url": {
                    "type": "string"
                  }
                },
                "example": {
                  "rpid": 12345683,
                  "cp_name_cart": "An updated CP name",
                  "rp_name_cart": "An updated RP name",
                  "rp_pic_url": "https://img.valuechecker.net/200x,---.jpg",
                  "rp_price_date": "2024-05-07 10:13:44",
                  "replacement_cost_value": 638.95,
                  "date_damage": "2024-05-07",
                  "date_purchase": "2024-05-01",
                  "cp_price_estimate": 650.0,
                  "claimed_amount": 650.0,
                  "offer_id": 123,
                  "shop_name": "Some shop - Global",
                  "shop_url": "https://www.some.shop/path"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/appraisal_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 11:57:46 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "0"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "a0c6fdd5-4844-48b3-b1b8-06fdee3f2d88"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {}
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Appraisal id 239055 was not found",
                  "event_code": "ERNFAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"appraisal_id\" value",
                    "description": "The appraisal_id \"239055\" was not found"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": ["Appraisals"],
        "summary": "Delete Appraisal",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/appraisal_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Wed, 26 Jul 2023 15:05:16 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "ff777227-f250-4d6b-adcb-4fca27fbb361"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {}
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Appraisal id 239055 was not found",
                  "event_code": "ERNFAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"appraisal_id\" value",
                    "description": "The appraisal_id \"239055\" was not found"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/client_reference/{client_reference_id}/appraisal/{appraisal_id}/acv": {
      "put": {
        "tags": ["Valuation"],
        "summary": "Calculate ACV",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "actual_cash_value": {
                    "type": "number",
                    "multipleOf": 0.01
                  },
                  "acv_incl_tax": {
                    "type": "integer"
                  },
                  "date_damage": {
                    "type": "string",
                    "format": "date",
                    "description": "The date of the submitted damage for this product."
                  },
                  "date_claim": {
                    "type": "string",
                    "format": "date",
                    "description": "The date of the submitted claim for this product. This field is deprecated and will be removed on 2025-11-01, use `date_damage` instead.",
                    "deprecated": true
                  },
                  "date_purchase": {
                    "type": "string",
                    "format": "date",
                    "description": "The date of purchase as reported by the claimant."
                  },
                  "depr_extra_one_year_no_receipt": {
                    "type": "boolean"
                  },
                  "homepage_client_category_id": {
                    "type": "integer"
                  },
                  "is_acv_cp_price_estimate_based": {
                    "type": "boolean",
                    "deprecated": true,
                    "description": "Use 'is_compensation_based_on_claimed_amount' instead. This field will be removed in a future version."
                  },
                  "is_compensation_based_on_claimed_amount": {
                    "type": "boolean",
                    "description": "Base the ACV calculation on the value from `claimed_amount` (Purchase Price / Repair) instead of Replacement Cost."
                  },
                  "item_quantity": {
                    "type": "integer"
                  },
                  "selected_client_category_id": {
                    "type": "integer",
                    "description": "(Optional) The identifier for the category that the ACV algorithm is to use for calculation. This value is client specific. **Note**: This is not necessarily the same as or related to the product category (client category id) used for the Claimed Product search. Please ask your ValueChecker support contact for more information."
                  },
                  "update_time": {
                    "type": "string",
                    "format": "date-time"
                  }
                },
                "example": {
                  "actual_cash_value": 221.2,
                  "acv_incl_tax": 0,
                  "date_damage": "2024-05-07",
                  "date_purchase": "2024-05-01",
                  "depr_extra_one_year_no_receipt": false,
                  "homepage_client_category_id": 12922,
                  "is_acv_cp_price_estimate_based": false,
                  "is_compensation_based_on_claimed_amount": false,
                  "item_quantity": 1,
                  "selected_client_category_id": 12922,
                  "update_time": "2024-05-07 10:36:44"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/appraisal_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Wed, 26 Jul 2023 15:12:13 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "0"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "8b00105c-5665-42fd-b001-766c154b13fe"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {}
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "The replacement cost value is needed to calculate the ACV.",
                  "event_code": "ERMPAV",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Missing parameter",
                    "description": "The replacement_cost_value is needed to calculate the ACV."
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Appraisal id 239055 was not found",
                  "event_code": "ERNFAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"appraisal_id\" value",
                    "description": "The appraisal_id \"239055\" was not found"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": ["Valuation"],
        "summary": "Delete ACV Calculation",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/appraisal_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Wed, 26 Jul 2023 15:05:16 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "ff777227-f250-4d6b-adcb-4fca27fbb361"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                },
                "example": {}
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Appraisal id 239055 was not found",
                  "event_code": "ERNFAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"appraisal_id\" value",
                    "description": "The appraisal_id \"239055\" was not found"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/client_reference/{client_reference_id}/appraisal/{appraisal_id}/appraisal_status": {
      "put": {
        "tags": ["Appraisal Statuses"],
        "summary": "Update Appraisal Status",
        "description": "Set or update the status of a specific appraisal",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          },
          {
            "name": "client_reference_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "integer"
            },
            "description": "The client reference identifier."
          },
          {
            "name": "appraisal_id",
            "required": true,
            "in": "path",
            "schema": {
              "type": "integer"
            },
            "description": "The appraisal identifier."
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "appraisal_status_id": {
                    "type": "integer",
                    "description": "The ID of the status to assign to the appraisal"
                  }
                },
                "required": ["appraisal_status_id"]
              },
              "example": {
                "appraisal_status_id": 2
              }
            }
          }
        },
        "responses": {
          "204": {
            "description": "Appraisal status updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "example": {}
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Non-existent appraisal_status_id and/or appraisal_status_id",
                  "event_code": "ERWPAP",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Incorrect param.",
                    "description": "Incorrect param."
                  }
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "title": "Required feature is not enabled.",
                  "description": "Please contact support to have this feature enabled."
                }
              }
            }
          }
        }
      }
    },
    "/client_reference/{client_reference_id}/report/pdf": {
      "post": {
        "tags": ["Reports"],
        "summary": "Generate Report",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "language": {
                    "type": "string"
                  },
                  "client_id": {
                    "type": "integer",
                    "description": "The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional."
                  },
                  "session-id": {
                    "type": "string",
                    "description": "Optional session identifier of the user."
                  },
                  "appraisal_ids": {
                    "type": "array",
                    "items": {
                      "type": "integer"
                    },
                    "description": "Optional list of appraisal_ids. If its not provided, Report will be generated for all appraisals in the claim. If provided, Report will be generated only for the provided appraisal_ids."
                  }
                },
                "example": {
                  "language": "en",
                  "client_id": 10,
                  "appraisal_ids": [715628, 715629]
                }
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Wed, 26 Jul 2023 15:15:20 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "106"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "aab7f42d-1dae-4bc7-8c2d-3f14f8d60b64"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                },
                "example": "https://files.valuechecker.net/reports/ValueChecker Claim Report - james bond - 2023-7-26 1583693-11.pdf"
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 14418 was not found",
                  "event_code": "ERNF00",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong 'client_reference_id' value",
                    "description": "The client_reference_id '14418' was not found"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/client_reference/{client_reference_id}/portal/customer/access": {
      "post": {
        "tags": ["Customer Portal"],
        "summary": "Create Portal Link",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "access_pin": {
                    "type": "string",
                    "description": "Must contain 4 numbers."
                  },
                  "client_id": {
                    "type": "integer",
                    "description": "The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional."
                  },
                  "session-id": {
                    "type": "string",
                    "description": "Optional session identifier of the user."
                  }
                }
              },
              "example": {
                "access_pin": "1234"
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          }
        ],
        "responses": {
          "201": {
            "description": "Created",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:10:05 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "66"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "93bb1e26-0d81-4d82-8ada-f40b10eabb50"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerPortalLink"
                },
                "example": {
                  "client_reference_id": 9337,
                  "client_reference": "Reference 321",
                  "link": "https://inventory.valuechecker.ai/549b2a",
                  "access_pin": "1234",
                  "link_status": "active"
                }
              }
            }
          },
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:10:05 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "66"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "93bb1e26-0d81-4d82-8ada-f40b10eabb50"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerPortalLink"
                },
                "example": {
                  "client_reference_id": 9337,
                  "client_reference": "Reference 321",
                  "link": "https://inventory.valuechecker.ai/549b2a",
                  "access_pin": "1234",
                  "link_status": "active"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 9337 was not found",
                  "event_code": "ERNF00",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"client_reference_id\" value",
                    "description": "The client_reference_id \"9337\" was not found"
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      },
      "get": {
        "tags": ["Customer Portal"],
        "summary": "Get Portal Link",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          },
          {
            "$ref": "#/components/parameters/client_reference_id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:03:35 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "85"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "945ccee0-a255-403b-9a32-863a5f2f2c6a"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerPortalLink"
                },
                "example": {
                  "client_reference_id": 9337,
                  "client_reference": "Reference 321",
                  "link": "https://inventory.valuechecker.ai/549b2a",
                  "access_pin": "1234",
                  "link_status": "active"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 9337 was not found",
                  "event_code": "ERNF00",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"client_reference_id\" value",
                    "description": "The \"client_reference_id\" \"9337\" was not found"
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": ["Customer Portal"],
        "summary": "Update Portal Link",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "access_pin": {
                    "type": "string",
                    "description": "Must contain 4 numbers."
                  },
                  "link_status": {
                    "type": "string",
                    "enum": ["active", "submitted", "locked"]
                  }
                }
              },
              "example": {
                "access_pin": "4321",
                "link_status": "locked"
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:10:05 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "66"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "93bb1e26-0d81-4d82-8ada-f40b10eabb50"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerPortalLink"
                },
                "example": {
                  "client_reference_id": 9337,
                  "client_reference": "Reference 321",
                  "link": "https://inventory.valuechecker.ai/549b2a",
                  "access_pin": "4321",
                  "link_status": "locked"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 9337 was not found",
                  "event_code": "ERNF00",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"client_reference_id\" value",
                    "description": "The client_reference_id \"9337\" was not found"
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      }
    },
    "/client_reference/{client_reference_id}/portal/customer/send": {
      "post": {
        "tags": ["Customer Portal"],
        "summary": "Send Appraisals to Portal",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "client_id": {
                    "type": "integer",
                    "description": "The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional."
                  },
                  "session-id": {
                    "type": "string",
                    "description": "Optional session identifier of the user."
                  }
                }
              },
              "example": {}
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 09:10:05 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "66"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "93bb1e26-0d81-4d82-8ada-f40b10eabb50"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SendAppraisalsToCustomerPortalResponse"
                },
                "example": {
                  "client_reference_id": 9337,
                  "sent_result": [
                    {
                      "display_id": 194,
                      "row_id": 1,
                      "location_id": "",
                      "location": "",
                      "quantity": 1.0,
                      "description": "193",
                      "condition": 2,
                      "cost": 0.0,
                      "total": 0.0,
                      "age": "",
                      "notes": "",
                      "files": [""],
                      "create_time": "2025-03-11 10:18:26",
                      "update_time": "2025-03-11 10:18:26",
                      "pid": 2273807050
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 9337 was not found",
                  "event_code": "ERNF00",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"client_reference_id\" value",
                    "description": "The client_reference_id \"9337\" was not found"
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      }
    },
    "/client_reference/{client_reference_id}/portal/customer/load": {
      "get": {
        "tags": ["Customer Portal"],
        "summary": "Load Inventory from Portal",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          },
          {
            "name": "force_load",
            "in": "query",
            "required": false,
            "description": "Optional boolean value. When `true`, all inventory data is processed potentially overwriting any changes made by the advocate in the Standalone to previously loaded data. This can be a heavy operation on large inventories. Use intentionally when needed. When `false` (or not present), only new Inventory items are processed. This is the default behavior.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Date": {
                "schema": {
                  "type": "string",
                  "example": "Tue, 25 Jul 2023 11:48:58 GMT"
                }
              },
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              },
              "Content-Length": {
                "schema": {
                  "type": "integer",
                  "example": "330017"
                }
              },
              "Connection": {
                "schema": {
                  "type": "string",
                  "example": "keep-alive"
                }
              },
              "x-request-id": {
                "schema": {
                  "type": "string",
                  "example": "5f6962fe-5c32-4d8d-ad17-0bca391b0c19"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "example": {}
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "event_code": {
                      "type": "string"
                    },
                    "event_dict": {
                      "type": "object",
                      "properties": {
                        "event_severity": {
                          "type": "string"
                        },
                        "title": {
                          "type": "string"
                        },
                        "description": {
                          "type": "string"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "error": "Client reference 9337 was not found",
                  "event_code": "ERNF00",
                  "event_dict": {
                    "event_severity": "ERROR",
                    "title": "Wrong \"client_reference_id\" value",
                    "description": "The client_reference_id \"9337\" was not found"
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      }
    },
    "/forensics/analyze": {
      "post": {
        "tags": ["Forensics"],
        "summary": "Analyze Image",
        "description": "Statelessly analyze a single image for AI generation and digital manipulation. No client reference or appraisal is involved: pass the image directly and get the verdicts back. Requires the Fraud Detection feature.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["image"],
                "properties": {
                  "image": {
                    "type": "string",
                    "minLength": 1,
                    "description": "The image to analyze: either a publicly reachable URL or a base-64-encoded image string."
                  }
                }
              },
              "example": {
                "image": "https://img.valuechecker.net/attachments/receipt_front.jpg"
              }
            }
          }
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK - Returns the forensics verdicts for the image. All fields are `null` when no analysis could be produced.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "is_ai_generated": {
                      "type": "boolean",
                      "nullable": true,
                      "description": "Whether the image was judged AI-generated."
                    },
                    "is_digitally_manipulated": {
                      "type": "boolean",
                      "nullable": true,
                      "description": "Whether the image was judged digitally manipulated."
                    },
                    "ai_generated_confidence": {
                      "type": "number",
                      "nullable": true,
                      "description": "Confidence (0-1) of the AI-generated verdict."
                    },
                    "manipulation_confidence": {
                      "type": "number",
                      "nullable": true,
                      "description": "Confidence (0-1) of the manipulation verdict."
                    },
                    "confidence": {
                      "type": "number",
                      "nullable": true,
                      "description": "The higher of the two confidences, for consumers that expect one overall score."
                    },
                    "analysis": {
                      "type": "string",
                      "nullable": true,
                      "description": "Free-text explanation of the verdicts."
                    },
                    "detect_edits": {
                      "type": "object",
                      "nullable": true,
                      "description": "Present only when the image is manipulated and the edit detection succeeded. `regions` is empty when the manipulation is not localized.",
                      "properties": {
                        "regions": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/ForensicsRegion"
                          }
                        }
                      }
                    }
                  }
                },
                "example": {
                  "is_ai_generated": false,
                  "is_digitally_manipulated": true,
                  "ai_generated_confidence": 0.08,
                  "manipulation_confidence": 0.91,
                  "confidence": 0.91,
                  "analysis": "The price region shows resampling artifacts inconsistent with the surrounding pixels.",
                  "detect_edits": {
                    "regions": [
                      {
                        "x_min": 0.31,
                        "y_min": 0.44,
                        "x_max": 0.52,
                        "y_max": 0.55
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "title": "Invalid analyze payload.",
                  "description": "image: Field required"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          }
        }
      }
    },
    "/forensics/{client_reference_id}/progress": {
      "get": {
        "tags": ["Forensics"],
        "summary": "Get Forensics Progress",
        "description": "Return the aggregate forensics state for a client reference. This is the progress indicator only: the verdicts themselves are returned by the results endpoints. The client reference stays `in_progress` while its images are still being processed, so a transition away from `in_progress` is the signal that forensics has finished.",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK - Returns the aggregate forensics state.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "forensics_state": {
                      "type": "string",
                      "enum": ["clear", "in_progress", "has_flagged_images"],
                      "description": "`in_progress` takes precedence over `has_flagged_images`: the client reference reports `in_progress` until it is fully analyzed, then settles on `has_flagged_images` or `clear`."
                    }
                  }
                },
                "example": {
                  "forensics_state": "has_flagged_images"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          }
        }
      }
    },
    "/forensics/{client_reference_id}/results": {
      "get": {
        "tags": ["Forensics"],
        "summary": "Get Appraisal Forensics Results",
        "description": "Return the per-attachment forensics status and verdicts for a single appraisal, scoped with the `appraisal_id` query parameter. Use it to show a status and verdict per image.",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "name": "appraisal_id",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer"
            },
            "example": "97771",
            "description": "The appraisal identifier."
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK - One entry per analyzed attachment. Empty when the appraisal has no analyzed attachments.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "forensics_results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/ForensicsResult"
                      }
                    }
                  }
                },
                "example": {
                  "forensics_results": [
                    {
                      "row_id": 41827,
                      "file_name": "receipt_front.jpg",
                      "status": "complete",
                      "is_ai_generated": false,
                      "is_digitally_manipulated": true,
                      "ai_generated_confidence": 0.08,
                      "manipulation_confidence": 0.91,
                      "confidence": 0.91,
                      "analysis": "The price region shows resampling artifacts inconsistent with the surrounding pixels.",
                      "regions": [
                        {
                          "x_min": 0.31,
                          "y_min": 0.44,
                          "x_max": 0.52,
                          "y_max": 0.55
                        }
                      ],
                      "flagged": true,
                      "update_time": "2026-07-24T09:12:33"
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          }
        }
      }
    },
    "/forensics/{client_reference_id}/results/all": {
      "get": {
        "tags": ["Forensics"],
        "summary": "List Forensics Results",
        "description": "The client reference wide counterpart of the appraisal results endpoint: every appraisal's per-attachment results in one response, keyed by `appraisal_id`. Appraisals with no analyzed attachments are omitted, so an absent key means the same as an empty list.",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "responses": {
          "200": {
            "description": "OK - A map of `appraisal_id` to that appraisal's per-attachment results. Empty when the client reference has no analyzed attachments.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "forensics_results": {
                      "type": "object",
                      "description": "Keyed by `appraisal_id` (as a string).",
                      "additionalProperties": {
                        "type": "array",
                        "items": {
                          "$ref": "#/components/schemas/ForensicsResult"
                        }
                      }
                    }
                  }
                },
                "example": {
                  "forensics_results": {
                    "97771": [
                      {
                        "row_id": 41827,
                        "file_name": "receipt_front.jpg",
                        "status": "complete",
                        "is_ai_generated": false,
                        "is_digitally_manipulated": true,
                        "ai_generated_confidence": 0.08,
                        "manipulation_confidence": 0.91,
                        "confidence": 0.91,
                        "analysis": "The price region shows resampling artifacts inconsistent with the surrounding pixels.",
                        "regions": [
                          {
                            "x_min": 0.31,
                            "y_min": 0.44,
                            "x_max": 0.52,
                            "y_max": 0.55
                          }
                        ],
                        "flagged": true,
                        "update_time": "2026-07-24T09:12:33"
                      }
                    ]
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          }
        }
      }
    },
    "/forensics/{client_reference_id}/clear": {
      "post": {
        "tags": ["Forensics"],
        "summary": "Clear Forensics Verdict",
        "description": "Manually mark an attachment's forensics verdict as clean, for when a claim handler has reviewed a flagged image and accepted it. Clears both verdicts and the resulting flag. Because verdicts are stored per claimed item, this clears the attachment for every appraisal created from that item.",
        "parameters": [
          {
            "$ref": "#/components/parameters/client_reference_id"
          },
          {
            "$ref": "#/components/parameters/client_id"
          },
          {
            "$ref": "#/components/parameters/session-id"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["appraisal_id", "file_name"],
                "properties": {
                  "appraisal_id": {
                    "type": "integer",
                    "description": "The appraisal the attachment belongs to."
                  },
                  "file_name": {
                    "type": "string",
                    "description": "The attachment file name, as returned by the results endpoints."
                  }
                }
              },
              "example": {
                "appraisal_id": 97771,
                "file_name": "receipt_front.jpg"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK - The verdict was cleared.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "cleared": {
                      "type": "boolean"
                    }
                  }
                },
                "example": {
                  "cleared": true
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "title": "Invalid mark-clean payload.",
                  "description": "file_name: Field required"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string"
                    },
                    "description": {
                      "type": "string"
                    }
                  }
                },
                "example": {
                  "error": "Not Found",
                  "description": "No completed forensics verdict found for attachment 'receipt_front.jpg'."
                }
              }
            }
          }
        }
      }
    }
  }
}
