Terms Of Service

Initiate Terms of Service

Returns a URL where the end customer accepts BlindPay's terms of service. A person must open it in a browser and accept; it cannot be accepted through the API. After acceptance the browser is sent to redirect_url with tos_id as a query parameter, and a tos.accept webhook fires. Pass that tos_id (to_...) to Create Customer. idempotency_key is any unique string and cannot be reused.

post/v1/e/instances/{instance_id}/tos

Request

  • Base URL: https://blindpay.com (the document declares no server; this is the origin it was published from)
  • URL: https://blindpay.com/v1/e/instances/{instance_id}/tos
  • Auth: HTTP bearer

Path parameters

instance_idstring required
Example:in_000000000000

Request body

idempotency_keystring uuid required
customer_idstring nullable
redirect_urlstring uri nullable

Example request

{
  "idempotency_key": "123e4567-e89b-12d3-a456-426614174000",
  "customer_id": "re_000000000000"
}

Response

Initiate terms of service

urlstring uri required

Example response

{
  "url": "https://app.blindpay.com/e/terms-of-service?session_token=SESSION_TOKEN_FROM_INITIATE_TOS_RESPONSE"
}

Changes

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