You should have a
client_reference_id from
Step 1. Create Reference
(or Step1.1)
to use in the request path.
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).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
(or Step1.1)
to use in the request path.
Depending how the appraisal was created, the response may contain additional
values.
Delete All Appraisals
To remove all Appraisals from a reference, call the same endpoint without any parameters.This empties the Reference of all Appraisals but does not delete the actual
Reference itself.
View An Appraisal
Theappraisal_id (returned from Create Appraisal)
is required in addition to the client_reference_id.
Modify An Appraisal
Modifications are passed as parameters in the payload (formatted in JSON).Delete An Appraisal
To remove a specific Appraisal from a reference, pass theappraisal_id
in the path.
Access uploaded file URLs
Appraisal responses include anattachments 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.