Terms of Service

Get hosted ToS page context

Changed on

Returns non-PII context for the verify-web hosted ToS acceptance page.

get/v1/tos/{id}/hosted-context

Request

Path parameters

idstring required

ToS acceptance ID

Response

Hosted page context

idstring required

ToS acceptance ID

organizationIdstring required

Organization ID

customerIdstring nullable required

Customer ID when known

countryCodestring required

ISO 3166-1 alpha-2 country for partner agreement gating

customerTypestring required

BUSINESS or INDIVIDUAL

isEreborEnabledboolean required

Whether Erebor account agreements must be shown

isOneMoneyEnabledboolean required

Whether customer onboarding partner disclosures apply

isDueEnabledboolean required

Whether platform FX terms must be accepted for this hosted acceptance

isRelatedPersonAcceptanceboolean required

When set, acceptance is for a related person (UBO) session

acceptedAtstring nullable required

When fully accepted, ISO timestamp; otherwise null

Example response

{
  "id": "tos_abc123",
  "organizationId": "org_abc123",
  "customerId": "cus_abc123",
  "countryCode": "US",
  "customerType": "BUSINESS",
  "isOneMoneyEnabled": true
}

Changes