🚧

Important:

Request headers are required. See API basics introduction for more information.

Link collector user

Endpoint

POST /collector/link

• Links a user web session and email with it's associated user object.

📘

Note:

First time authentication requires QRCode linking as we need to link an email to the user. The QRCode simply contains a token as data and should be extracted to be passed to the endpoint.

Subsequent login can be made either via QRCode linking or via email where an OTP will be sent.

Request body

Request example

Sample: request body

{
  "qr_code_token": "833891972804325477585530216143",
  "user_uid": "111111111111"
}

Response

Response example

Sample: 200 Collector Link Response

{
  "success": true,
  "data": null
}

Example

The following example creates links a user 111111111111 to a collector qr code token 833891972804325477585530216143.

# API_KEY is your api key
# TOKEN is the access token generated with your api key secret

curl -i \
  -X POST \ 
  -d "{\"qr_code_token\":\"833891972804325477585530216143\",\"user_uid\":\"111111111111\"}" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: API_KEY" \
  -H "Authorization: Bearer TOKEN" \
  "https://api.getoriginal.com/v1/collector/link"