Skip to main content
Easily create and manage portal links using the Customer Portal Links. Manage access to the ValueChecker Portal via the API. Create and get access links, set or revoke access codes (PINs) and change status.
The ValueChecker Portal is a separate product that is not included in the ValueChecker API. The details listed below are only for managing access to the Portal.

​
Follow the steps below to automate access to the Portal

1

Create a client reference

Create Client Reference Endpoint➜
2

Create a portal link

POST to the endpoint with empty request body, or access_pin parameter to specify a PIN. The status will be active. If no PIN is supplied, a random 4 digit pin will be automatically generated.
Every Client Reference can only have 1 associated link. Any subsequent requests will be performed on the original record without creating a new link.
Create Customer Portal Link Endpoint➜
3

Portal data is submitted to the ValueChecker API

When the portal user submits their inventory, the link_status will have a value of submitted.GET the endpoint to receive current link_status and access_pin.
Get a Customer Portal Link Endpoint➜
4

Changing Portal status

  • To lock the portal use PATCH with link_status parameter of locked.
  • To unlock the portal use PATCH with link_status parameter of active.
Manage Customer Portal Link Endpoint➜

​
Reset the PIN

PATCH the endpoint specifying a new 4 digit PIN using the access_pin. PATCH the endpoint specifying a new status with link_status parameter. We accept 3 different statuses. a. active - default status of link after creating it with POST.
b. submitted - status after Portal user submits their inventory.
c. locked - if enabled, status restricts Portal user from editing their inventory.