HIhifi
User

Generate a terms of service link

The Terms of Service page must be displayed to the end user. This page can be whitelabeled upon request.

post/v2/tos-link

Request

  • Base URL
    https://production.hifibridge.com
  • URL
    https://production.hifibridge.com/v2/tos-link
  • Auth
    HTTP bearer

Request body

idempotencyKeystring uuid required

Unique identifier for the resource

templateIdstring

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.

redirectUrlstring

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

urlstring
signedAgreementIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.