Skip to main content
POST
/
client_reference
/
{client_reference_id}
/
portal
/
customer
/
access
Create Customer Portal Link
curl --request POST \
  --url https://api.valuechecker.net/client_reference/{client_reference_id}/portal/customer/access \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_pin": "1234"
}
'
{
  "client_reference_id": 9337,
  "client_reference": "Reference 321",
  "link": "https://inventory.valuechecker.ai/549b2a",
  "access_pin": "1234",
  "link_status": "active"
}

Authorizations

​
Authorization
string
header
required

Note! Prefix your with apiKey. Note the space after "apiKey ".

Path Parameters

​
client_reference_id
integer
required

The client reference identifier.

Body

application/json
​
access_pin
string

Must contain 4 numbers.

​
client_id
integer

The client ID for the request. It's required if you have access to multiple clients with your API key. Otherwise, it's optional.

​
session-id
string

Optional session identifier of the user.

Response

OK

​
client_category_id
integer
​
client_reference
string
​
link
string
​
access_pin
string
​
link_status
enum<string>
Available options:
active,
submitted,
locked