> ## Documentation Index
> Fetch the complete documentation index at: https://developer.valuechecker.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Appraisal

export const EndpointButton = ({title, href}) => <div className="button-container">
    <a className="button" href={href}>
      {title}
      <span className="arrow">➜</span>
    </a>
  </div>;

Creating an Appraisal record requires a Reference (or ‘cart’) id. A
Reference (or cart) can contain 1 or more Appraisals.\
You should have a `client_reference_id` from
[Step 1. Create Reference](/api-reference/create-client-reference)
(or [Step1.1](/api-reference/create-client-reference#list-all-references))
to use in the request path.

<Note>
  If an identical Appraisal record exists in the same `client_reference` (the
  same `cpid` and `rpid`), we will create a new appraisal record with a
  different identifier (`appraisal_id`).
</Note>

<EndpointButton title="Create Appraisal Endpoint" href="/api-reference/default/client_reference-appraisal-1" />

# View All Appraisals

To view all/any Appraisals within a reference, call the same endpoint
without any parameters.\
You should have a `client_reference_id` from
[Step 1. Create Reference](/api-reference/create-client-reference)
(or [Step1.1](/api-reference/create-client-reference#list-all-references))
to use in the request path.

<Note>
  Depending how the appraisal was created, the response may contain additional
  values.
</Note>

<EndpointButton title="All Appraisals In Specific Client Reference Endpoint" href="/api-reference/default/client_reference-appraisal" />

# Delete All Appraisals

To remove all Appraisals from a reference, call the same endpoint
without any parameters.

<Note>
  This empties the Reference of all Appraisals but does not delete the actual
  Reference itself.
</Note>

<EndpointButton title="Delete All Appraisals In Specific Client Reference Endpoint" href="/api-reference/default/client_reference-appraisal-2" />

# View An Appraisal

The `appraisal_id` (returned from [Create Appraisal](/api-reference/appraisals))
is required in addition to the `client_reference_id`.

<EndpointButton title="Get Specific Appraisal" href="/api-reference/default/client_reference-appraisal-3" />

# Modify An Appraisal

Modifications are passed as parameters in the payload (formatted in
JSON).

<EndpointButton title="Modify Specific Appraisal" href="/api-reference/default/client_reference-appraisal-4" />

# Delete An Appraisal

To remove a specific Appraisal from a reference, pass the `appraisal_id`
in the path.

<EndpointButton title="Delete Specific Appraisal" href="/api-reference/default/client_reference-appraisal-5" />

# Access uploaded file URLs

Appraisal responses include an `attachments` array for each appraisal. Each attachment has `url`, `file_name`, `type`, and `update_time`. Use the `url` values to access files that have been uploaded by the API user and attached to the appraisal (e.g. damage photos, receipts). These URLs are returned when viewing a specific appraisal or when listing appraisals in a reference.

# Batch upload (Excel)

You can submit Excel files containing multiple claimed items to the API for batch processing. This provides the same batch-upload workflow available in the ValueChecker frontend. Each file is processed to create or update appraisals in bulk.

# Get All Client References With Appraisals

For bulk operations and reporting, you can export all client references with their appraisals for all users within your client.

<EndpointButton title="Export Client References With Appraisals Endpoint" href="/api-reference/default/client_reference-appraisals" />