Create Appraisal
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
(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.
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
The appraisal_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 the appraisal_id
in the path.