Skip to main content
POST
/
v2
/
tos-link
Generate a terms of service link
curl --request POST \
  --url https://production.hifibridge.com/v2/tos-link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "idempotencyKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "templateId": "<string>",
  "redirectUrl": "<string>"
}'
{
  "url": "https://dashboard.hifibridge.com/accept-terms-of-service?sessionToken=e12d9c3f-75a8-4bd1-aa3d-97a2cfaf2c40&redirectUrl=undefined&templateId=2fb2da24-472a-4e5b-b160-038d9dc82a40",
  "signedAgreementId": "e12d9c3f-75a8-4bd1-aa3d-97a2cfaf2c40"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
idempotencyKey
string<uuid>
required

Unique identifier for the resource

​
templateId
string

Id of the custom terms of service template generated in the HIFI developer dashboard. If not passed, the page will use HIFI's default template.

​
redirectUrl
string

Url to redirect after accepting the terms of service link. The signedAgreementId is the same as the passed idempotencyKey, you may attempt to call the POST /user/create endpoint, but if the user did not accept the TOS, the user creation will return an error.

Response

Success

​
url
string
​
signedAgreementId
string
⌘I