Skip to main content
While not strictly required to use the ValueChecker API, it is good practice to create a Reference record prior to every usage session. Think of it as a shopping cart where Appraisal records are collected and can be modified prior to being retrieved into your system. The claim reference number of a policyholder’s claim can also be used as the Client Reference.
If your implementation is only using the CP and RP steps, you may skip creating a reference.
Client references have a user defined label (client_reference) and a client_reference_id. The client_reference_id is used to interact with the ValueChecker API to identify a reference.
Create Client Reference Endpoint➜

​
List All References

To list your existing references (or ‘Carts’), you can use the same endpoint. This returns all references belonging to the user the token belongs to. No parameters are required
All Client References Endpoint➜

​
Display Specific Reference

You should have a client_reference_id from Step 1: Create Client Reference to use in the request path.
Get Specific Client Reference Endpoint➜

​
Get All Client References With Appraisals

To get all client references with their appraisals for all users within your client, you can use this endpoint. This is useful for bulk data retrieval such as exports and reporting purposes.
# Get All Client References With Appraisals Endpoint➜